Webhooks allow external systems to trigger Heymarket automations by sending an HTTP POST request. This works with existing automation workflows, so webhook triggers can run the same actions such as sending messages, updating contacts, assigning conversations, or adding contacts to lists.
How It Works
- Create an automation with a Webhook trigger.
- Heymarket generates a Webhook URL and API key.
- An external system sends a POST request with JSON.
- JSON fields are mapped to contact fields.
- The automation runs its configured actions.
Common Use Cases
- Send SMS notifications when an event occurs in another system
- Send appointment reminders from scheduling platforms
- Trigger customer messages when orders are created or shipped
- Notify internal teams about operational alerts or incidents
- Send confirmations when users complete actions in an app
Setup
1. Create the Automation
Create a new automation: https://app.heymarket.com/automations/new/ and select the inbox that will send messages.
2. Select Webhook Trigger
Choose Webhook as the trigger type.
Heymarket generates a Webhook URL and API key.
3. Add Sample JSON
Paste a sample payload representing the data your external system will send.
Example:
{
"phone_number": "12155556677",
"first_name": "John",
"last_name": "Smith",
"Integration": "Salesforce"
}Then click Map fields.
Choose the identifier field (typically phone number).
5. Add Actions
Add automation actions such as Send Message.
Triggering the Webhook
External systems trigger the automation by sending an HTTP POST request.
Example:
curl -X POST "https://triggers.heymarket.com/automations/{automation_id}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {API_KEY}" \
-d '{
"phone_number": "12155556677",
"first_name": "John",
"last_name": "Smith",
"Integration": "Salesforce"
}'Successful requests return:
{
"message": "Request captured successfully"
}Requirements
Method: POST Content-Type: application/json Authorization header with Bearer API key Valid JSON payload