Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Add Subscription

API to add subscribers (users/child objects) to a given object, to notify subscribers when workflow is triggered on the parent object.

post/v1/object/{object_type}/{id}/subscription/

Path parameters

idstring required

Unique identifier of the object in your system

object_typestring required

Used to group similar objects together. Give plural namespace like teams, organizations, and roles.

Request body

propertiesobject

properties defining the relation between object and its subscribers. Can be referenced as recipient.subscription.<key> in workflow and template.

Example request

{
  "recipients": [
    {
      "$slack": [
        {
          "email": "user@example.com",
          "access_token": "xoxb-XXXXXXXX"
        }
      ],
      "$ms_teams": [
        {
          "tenant_id": "c1981ab2-9aaf-xxxx-xxxx",
          "service_url": "https://smba.trafficmanager.net/amer",
          "conversation_id": "19:c1524d7c-a06f-456f-8abe-xxxx"
        }
      ],
      "$locale": "en_GB"
    }
  ],
  "properties": {
    "role": "developer"
  }
}

Response

200

propertiesobject

object subscription properties, referred as $recipient.subscription.<key> in template or workflow.

created_atstring date-time

Timestamp when the subscription was created.

updated_atstring date-time

Timestamp when the subscription was last updated.

Example response

{
  "user": {
    "distinct_id": "_distinct_id_",
    "updated_at": "2025-04-04T09:55:12.422388+00:00"
  },
  "object": {
    "id": "frontend",
    "object_type": "frontend",
    "updated_at": "2025-04-04T09:55:12.422388+00:00"
  },
  "created_at": "2025-04-04T09:55:12.397856+00:00",
  "updated_at": "2025-04-04T09:55:12.422388+00:00"
}