The Webhooks feature allows you to forward incoming SMS or MMS messages directly to a defined URL endpoint in real time.
The Webhooks function enables automatic redirection of incoming messages to a defined URL. When enabled, every SMS or MMS received by SMSEagle will trigger an HTTP(S) request to your specified endpoint. The Webhooks feature also allows you to call an endpoint URL if the status of an outgoing message has changed (i.e. if the message was sent/delivered or an error occurred while sending). The request can use either the GET or POST method.
With Webhooks, you can easily forward incoming SMS/MMS messages to external systems. Every time a message is received, SMSEagle sends an HTTP(S) request to the URL you specify. You can create an unlimited number of webhook rules, each of which can be enabled or disabled individually.
For each new webhook rule, you’ll need to provide the following information:
URL – the address of your webhook endpoint.
Test URL – verifies that your webhook configuration works correctly. SMSEagle sends a test request with sample parameters and checks the server response.
URL method – choose between HTTP(S) GET or POST for the request type.
Send request when – define conditions for triggering the webhook. You can choose to send it always, only when the SMS sender is part of a specific Phonebook contact/group, or only when the incoming message contains a particular string.
API key of your service (optional) – if provided, SMSEagle will include this value as the apikey parameter in the webhook request. If left blank, no apikey parameter will be sent.
Expected HTTP Status Code(s): defines which HTTP response codes are treated as a successful webhook delivery. The webhook is considered OK only if the HTTP response status matches one of the specified codes. Default: 200
Self-signed SSL support – optionally enable support for self-signed SSL certificates.
After sending HTTP(S) GET/POST request to your callback URL, SMSEagle will be expecting HTTP response defined in parameter “Expected HTTP Status Code(s)”. If a different response or no response is received, SMSEagle will retry the request at user-defined intervals for up to 24 hours.
