Webhook Request Examples

curl --request POST \ --url https://{webhookUrl}/treble-webhooks \ --header 'Content-Type: application/json' \ --data ' { "event_type": "hsm.status", "event_id": "5f8d7e6a5f8d7e6a5f8d7e6a", "timestamp": "2024-09-10T12:34:56.789Z", "status": "APPROVED", "name": "welcome_message", "affected_conversation_ids": [ 12345, 67890, 54321 ] } '

Body

application/json

Event information. The type of event is determined by the 'event_type' field.

hsm.status
session.close
deployment.failure

Event that is triggered when the status of an HSM (Highly Structured Message) changes

event_type

enum<string>

required

Type of event, always 'hsm.status' for HSM status updates

Available options:

hsm.status

event_id

string

required

Unique identifier of the event

timestamp

string<date-time>

required

Timestamp of the event in ISO 8601 format

status

enum<string>

required

New status of the HSM

Available options:

APPROVED,

REJECTED,

PAUSED,

DISABLED,

PENDING_DELETION

name

string

required

Name or identifier of the HSM

affected_conversation_ids

integer[]

required

IDs of the conversations affected by the status change

ID of an affected conversation

Response

200 - application/json

Successful response

JSON object with the confirmation of reception. The service must respond in less than 5 seconds.

Introduction to API

API

Webhooks

Editor

Guides and Tutorials

Webhook Request Examples

Body

Response