Create an event
Create a conversation or append a customer message to an existing one.
ScalePOST
/api/v1/developer/eventsDeveloper API keyRequest body
| Field | Type | Description |
|---|---|---|
| event · required | string | conversation.created or message.created |
| external_id · required | string | Stable workspace-unique ID, 1–200 characters |
| conversation_id | string | Required for message.created; a conversation in this workspace |
| customer_email | string | Customer email |
| customer_name | string | Customer display name, stored up to 160 characters |
| subject | string | Conversation subject, stored up to 240 characters |
| body | string | Message text, up to 100,000 characters |
| body_html | string | Optional HTML message body |
| attachments | object[] | Attachment metadata, serialised size up to 100,000 characters |
| metadata | object | Custom context, serialised size up to 32,000 characters |
Create a conversation
curl https://api.pingback.live/api/v1/developer/events \
-H "Authorization: Bearer $PINGBACK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event": "conversation.created",
"external_id": "order-123-support",
"customer_email": "[email protected]",
"customer_name": "Amara",
"subject": "Delivery question",
"body": "Can I update my delivery address?"
}'Add a message
{
"event": "message.created",
"external_id": "order-123-follow-up",
"conversation_id": "conv_example",
"body": "The new address is 42 Example Road."
}Response
{
"status": "accepted",
"event": "conversation.created",
"resource_id": "conv_example",
"event_id": "dev_evt_example"
}{
"status": "duplicate",
"event": "conversation.created",
"resource_id": "conv_example"
}