Webhook Payload

All payloads will contain the following common properties, but the contents and structure of each payload varies depending on the event, you are subscribed to. Refer to each event’s reference document to see which fields will be included.

Example:

{
    "CommunityName": "communityName",
    "EventType": "event_name",
    "Events": [],
    "TicketId": 0
}
Field
Type
Comments

CommunityName

string

Name of the socialboards inbox in which the tickets, replies and notes enters the system

Event type

string

Type of happened event. See Events page for more details

Events

Array

Event payload (structure depends on event type)

TicketId

integer

Id of a ticket caused this event.

Last updated