SUsuprsend

Trigger an Event

Changed on

API to pass an event, which in turn triggers workflows where that event is defined as the trigger.

post/event/

Request

Request body

distinct_idstring required

distinct_id of recipient who should receive the notification

eventstring required

string identifier for the event like product_purchased

tenant_idstring

string identifier of the tenant this event is associated with

$idempotency_keystring

Idempotency key (valid for 24hours)

cancellation_keystring

Lookup key stored on each execution this event triggers, so a Cancel Workflow node can later stop them by matching on it. Pass a literal string (max 512 characters; longer values are truncated). Overrides a target workflow's own Trigger-node Cancellation Key expression when both are present.

Example request

{
  "properties": {
    "$attachments": [
      {
        "url": "https://bitcoincore.org/bitcoin.pdf",
        "filename": "billing.pdf"
      }
    ]
  },
  "cancellation_key": "booking-123"
}

Response

202 - Accepted

Changes

  • b29a684058d6Revision changes
    • info

      added the new optional request property

  • 5f0169085547Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      added the media type text/plain for the response with the status