Skip to main content
WEBHOOK
Use this page to review the generated payload schema for webhook deliveries.

Body

application/json

Payload Heymarket posts to configured webhook URLs.

type
enum<string>
required

Heymarket webhook event type. message_recieved preserves the current API spelling.

Available options:
message_sent,
message_recieved,
chat_reassigned,
chat_closed,
chat_opened,
chat_pending,
chat_transferred,
target_opt_out,
target_opt_in,
target_double_opt_in,
target_double_opt_restricted,
incoming_call
id
integer
required

Webhook configuration ID.

token
string
required

Webhook verification token generated for the webhook configuration.

event_data
object
required

Event payload. Message events send a Message, chat events send a Conversation, and opt-in/opt-out events send an UnSubscribed payload.

Response

Webhook event accepted.