Form submitted

This webhook can post a request to your API when a session (transaction) is submitted by end-client. This API is different from archive. While archive is posting the entire session data and documents, form submitted is a notification when submit is clicked and verified in Cellosign application.

Why do I need this?

Use this API if you need to track lapse time for client completion, submitted to archive or creating new session in a flow

Form submitted 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_SUBMITTED 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_SUBMITTED",
    "timestamp": "2025-01-26T09:35:39.829692"
  },
  "session": {
    "id": "mWPLQ0nDqw",
    "reference": "9bfb3574-6ffb-4e43-be47-c6001a39ad79",
    "process_id": "9bfb3574-6ffb-4e43-be47-c6001a39ad79",
    "process_number": 39,
    "transaction_number": 10,
    "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": ""
}