Session expired

This webhook can post a request to your API when a session (transaction) status turned expired. It is not deleted yet but it is no longer accessible and cannot be recovered by extending the session.

Why do I need this?

This API is similar to Session deleted, however it occurs before deleted mostly in minutes when it comes to a standalone transaction (which is not part of a workflow) or days when it is part of a workflow.

Session expired 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_EXPIRED 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_EXPIRED",
    "timestamp": "2025-01-26T09:20:03.439650"
  },
  "session": {
    "id": "xM72By4JkM",
    "reference": "2d12cdb3-d666-4dbd-8827-d7c165ed9d17",
    "process_id": "2d12cdb3-d666-4dbd-8827-d7c165ed9d17",
    "process_number": 28,
    "transaction_number": 17,
    "recipient": {
      "id": 1,
      "name": "client"
    },
    "labels": {
      "CUSTOMER_TAG": "CUSTOMER_VALUE"
    }
  }
}

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.

{
  "data": [
    {
      "id": "OrderId",
      "value": "1234-45"
    },
    {
      "id": "OrderStatus",
      "value": "Open"
    }
  ]
}