Skip to main content
Webhooks send event notifications from Heymarket to your server. Use them when your integration needs to react to inbound messages, outbound message updates, conversation changes, or other team activity without polling the API.

​
How webhooks fit into the API

The REST API lets your integration fetch and mutate Heymarket data. Webhooks notify your integration when something changes. A typical integration uses both:
  • Webhooks to receive real-time events.
  • REST API calls to look up related objects or perform follow-up actions.
Use webhooks for real-time workflows such as inbound replies, opt-outs, and conversation assignment changes. Use REST API calls when you need to backfill history, reconcile missed events, or run a periodic sync.

​
Receiver requirements

Your webhook receiver should:
  • Accept HTTPS POST requests from Heymarket.
  • Parse JSON request bodies.
  • Validate the webhook token value.
  • Return a 2xx response quickly after receiving the event.
  • Move slow work to a queue or background job.
  • Log event IDs or request metadata for troubleshooting.

​
Security

Keep webhook URLs private. Do not commit them to public code, expose them in client-side applications, or reuse them across unrelated environments. Validate the webhook token before processing events. If you also include an unguessable token in the URL path, treat it as an extra control rather than the only validation step.

Webhook guide

Configure and receive webhook events.

Messages

Understand the message objects commonly sent in webhook payloads.

Webhook event reference

Review the generated event payload schema.