Introduction to Webhooks
Learn how to create webhooks in Zixflow to receive real-time updates for incoming messages and more.
๐ Webhooks in Zixflow
Zixflow webhooks allow you to receive real-time notifications when specific events happen in your accountโsuch as an incoming WhatsApp or RCS message. This enables your system to act on these updates automatically and integrate them into your workflows.
๐ ๏ธ How to Create a Webhook
To set up a webhook in Zixflow:
- Navigate to the Zixflow application.
- Go to the Settings section.
- Open the Developer section.
- Click on Webhook.
- Click on the โ Add button.
You will now be asked to fill in the following details:
๐ท๏ธ Name
- A name for your webhook.
- Character Limit: 50 characters.
๐ Endpoint
- The public URL (HTTP POST endpoint) where Zixflow will send webhook requests.
- Character Limit: 500 characters.
- Must be accessible from the internet.
๐ฏ Events
Select the events you want to subscribe to. Currently supported events:
incoming.whatsapp.message
incoming.rcs.message
๐งช Filter (Optional)
You can optionally filter events to only receive messages from specific accounts:
- WhatsApp: Choose a specific WhatsApp account or leave it blank to receive events from all.
- RCS: Same behavior applies.
๐ฆ Data Type
Choose the type of data you want to receive:
- Only Event: Only metadata about the event is sent (e.g., โnew message receivedโ).
- Event with Data: Full message payload is included in the webhook.
โ๏ธ Advanced Settings
You can add custom headers (e.g., authentication tokens, secret keys) for validating incoming requests on your server.
๐ Retry Mechanism
If your webhook endpoint is down or returns a non-2xx status, Zixflow will automatically retry the request using the following backoff strategy:
Retry Delays (in seconds): 15, 40, 180, 600, 3600, 21600, 43200, 86400, 172800
โ๏ธ If the webhook continues to fail after all retries, it will be disabled for stability reasons.
Next: Learn about Webhook Event Types and their data schema.