Post notification when a new session created in workflow

This webhook can post a request to your API when a new session (transaction) is created in Cellosign database..

Why do I need this?

It is best used if you need to track, programmatically the advancement of a business process (workflow or BPM). Let’s assume that you have a recruitment process started in Cellosign and you want each stage (or station) to report when a form to the next station has been posted to recipient.

session created request and response

Following are definitions for Body request posted from Cellosign to your API

Element	What it’s for?
Event	Object that includes Event type: WHEF_SESSION_CREATED and time stamp
Session	This object includes details on the session the webhook was fired from. It includes the following elements: 1. “id”: session token 2. “reference”: aggregator ID for business process. 3. “transaction_number”: ID for transaction that can be located in cellosign UI application 4. “recipient”: in case of a workflow this will indicate the recipient id in the process and it’s convention name 5. “labels”: This is a key value object in reference to values injected to labels. See API documentation for details
recipient	The id of the recipient and convention
labels	Any key/value that is associated with the session

Example post request

{
  "event": {
    "type": "WHEF_SESSION_CREATED",
    "timestamp": "2025-01-26T08:49:33.626046"
  },
  "session": {
    "id": "5Wkt78ciJc",
    "reference": "7932390e-ee95-4888-ba64-9c7e6f2f5908",
    "process_id": "7932390e-ee95-4888-ba64-9c7e6f2f5908",
    "process_number": 51,
    "transaction_number": 53,
    "recipient": {
      "id": 1,
      "name": "client"
    },
    "labels": {
      "CUSTOMER_TAG": "CUSTOMER_VALUE"
    }
  }
}

Expected response

A successful response from the API must include status: “0”, Otherwise “-1”.

{
  "status": "0",
  "errordesc": ""
}