Skip to main content
WEBHOOK
heymarketEvent
{
  "id": 123,
  "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>",
    "status": "<string>",
    "super": 123,
    "support": true,
    "target": "<string>",
    "text": "<string>",
    "type": "<string>",
    "updated": "<string>",
    "user": 123
  }
}
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.