Webhooks

Message Events

Receive inbound messages and message status updates via webhook. See our guide for handling events with SDKs.

Headers

PINNACLE-SIGNING-SECRETstringRequired
Secret for verifying the authenticity of the request. Starts with `pss-` and is unique for each webhook. Find it at [webhooks](https://app.pinnacle.sh/dashboard/development/webhooks).

Payload

The payload of this webhook request is an object.
typeenumRequired
Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages.
Allowed values:
conversationobjectRequired
Conversation metadata containing the conversation ID, sender, and recipient information.
statusenumRequired
Current status of the message.
directionenumRequired
Direction of the message flow.
Allowed values:
segmentsintegerRequired
Number of segments for this message.
sentAtstringRequired
Timestamp when the message was sent in ISO 8601 format.
messageobjectRequired

Content of an incoming or outgoing message. Discriminated by the type field.

deliveredAtstring or nullOptional
Timestamp when the message was delivered in ISO 8601 format. Null if not yet delivered or for inbound messages.

Response

200
any
Return a 200 status to indicate that the data was received successfully.