Logged in and Form loaded

The post request is identical in both “Logged in” and “Form loaded”.

1. Logged in is triggered when client logs in to a form in any mean, such as click on URL in SMS or email
2. Form loaded is triggered when a form is fully loaded into client browser and is operational.

Form loaded 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_CLIENT_FORM_LOADED or WHEF_CLIENT_LOGGED_IN 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
client	Object that includes basic information regards the browser that webhook was fired form

Example post request

Your API can expect this API example for getting information from your API.

{
  "event": {
    "type": "WHEF_CLIENT_FORM_LOADED",
    "timestamp": "2025-01-26T10:54:28.291796"
  },
  "session": {
    "id": "bkIUKTHxws",
    "reference": "cbbdd32e-8c97-4ec8-a20f-3b6d4d7be2fd",
    "process_id": "cbbdd32e-8c97-4ec8-a20f-3b6d4d7be2fd",
    "process_number": 2,
    "transaction_number": 7,
    "recipient": {
      "id": 1,
      "name": "client"
    },
    "labels": {
      "CUSTOMER_TAG": "CUSTOMER_VALUE"
    }
  },
  "client": {
    "ip": "127.0.0.1",
    "user_agent": "Best browser ever",
    "device": "mobile"
  }
}

Expected response

A successful response from the API should include array of objects, were each object includes “id” and “value” key/value pairs as in this example. Values will be injected into their corresponding id in a session.

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