Receive webhook event
Schema for the Heymarket webhook event callback.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"event_data": {
"author": "<string>",
"broadcast_id": 123,
"conversation": {
"assigned": 123,
"blocked": true,
"channel": "<string>",
"created": "<string>",
"creator": 123,
"email_noti": true,
"id": 123,
"inbox": 123,
"last_inbound": 123,
"local_id": "<string>",
"members": [
{
"id": 123,
"name": "<string>"
}
],
"muted": true,
"name": "<string>",
"noreply": "<string>",
"op": "<string>",
"read": 123,
"replied": true,
"snooze_till": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"type": "<string>",
"updated": "<string>"
},
"custom": {
"data": [
123
],
"type": "<string>"
},
"date": "<string>",
"flagged": true,
"id": 123,
"link_url": "<string>",
"local_id": "<string>",
"media": "<string>",
"phone": "<string>",
"raw_error": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"target_errors": {},
"text": "<string>",
"type": "<string>",
"updated": "<string>",
"user": 123
}
}Body
Payload Heymarket posts to configured webhook URLs.
Heymarket webhook event type. message_recieved preserves the current API spelling. message_failed is sent when an outbound message fails, either at send time or when the carrier reports a delivery failure; its payload carries status and raw_error. private_comment_created is sent when a private comment is created in the Heymarket app or through the public API with private set to true, only to webhooks with "Include private comments" enabled (off by default). Its payload is a Message with type memo (or group:memo for group conversations), user set to the creator, and author when one was supplied. Private comments added by AI agents or the Help Scout integration do not send this event.
message_sent, message_recieved, message_failed, 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, private_comment_created Unique ID of this event. Every webhook that receives the same event gets the same ID.
Webhook verification token generated for the webhook configuration.
Event payload. Message events send a Message, chat events send a Conversation, and opt-in/opt-out events send an UnSubscribed payload.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Response
Webhook event accepted.
Was this page helpful?
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"event_data": {
"author": "<string>",
"broadcast_id": 123,
"conversation": {
"assigned": 123,
"blocked": true,
"channel": "<string>",
"created": "<string>",
"creator": 123,
"email_noti": true,
"id": 123,
"inbox": 123,
"last_inbound": 123,
"local_id": "<string>",
"members": [
{
"id": 123,
"name": "<string>"
}
],
"muted": true,
"name": "<string>",
"noreply": "<string>",
"op": "<string>",
"read": 123,
"replied": true,
"snooze_till": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"type": "<string>",
"updated": "<string>"
},
"custom": {
"data": [
123
],
"type": "<string>"
},
"date": "<string>",
"flagged": true,
"id": 123,
"link_url": "<string>",
"local_id": "<string>",
"media": "<string>",
"phone": "<string>",
"raw_error": "<string>",
"status": "<string>",
"super": 123,
"support": true,
"target": "<string>",
"target_errors": {},
"text": "<string>",
"type": "<string>",
"updated": "<string>",
"user": 123
}
}