Skip to main content

Ticket webhook events

Reference ticket create, update, close, and comment webhook payloads.

Written by Geoff Mina

This reference covers the webhook event names currently available for this record type and an example JSON payload.

X-Event-Type values

  • TicketCreate

  • TicketUpdate

  • TicketClose

  • TicketComment

Payloads reflect the record at delivery time and may gain additional fields. Integrations should ignore unknown fields and use the event type plus stable record IDs rather than depending on property order.

Example payload

{
"ticket": {
"id": "664f35811408101c26c105f0",
"accountId": 10016,
"clientId": "6592a98d5715034f5db5cfb8",
"clientContactId": -894,
"ticketNumber": 1006,
"ccList": [],
"assignedTo": [],
"dueDate": "2024-06-01",
"subject": "Please do some work for me!",
"open": true,
"type": "2be2f7e5-8806-4de2-85fa-c6aa0a235c58",
"status": "New",
"unread": false,
"unreadClient": true,
"lastComment": "This is going to be some rad comment here that is really awesome.",
"formData": {
answers": [
{
"id": null,
"fieldKey": "ProjectType",
"fieldType": null,
"question": "What type of project do you need?",
"answer": "Website design"
},
{
"id": null,
"fieldKey": "Platform",
"fieldType": null,
"question": "What platform are we developing assets for?",
"answer": "Instagram"
}
]
},
"created": "2024-05-23T12:24:33.349Z",
"updated": "2024-05-23T12:24:33.349Z"
},
"comments": [
{
"id": "664f35811408101c26c105f1",
"accountId": 10016,
"ticketId": "664f35811408101c26c105f0",
"commentType": "PUBLIC",
"commentBy": -894,
"commentUserEmail": "user@email.com",
"commentUserName": "Geoff Mina",
"attachments": [],
"comment": "This is going to be some rad comment here that is really awesome.",
"fromEmail": false,
"created": "2024-05-23T12:24:33.420Z",
"updated": null,
"commentFormat": "PlainText"
}
]
}

For delivery setup and troubleshooting, see Configure event webhooks. The generated Webhooks & Events documentation is the source of truth for the current event catalog.

Did this answer your question?