Infobip · AsyncAPI Specification
Infobip platform webhooks
Version 3.210.0
AsyncAPI projection of the 102 webhooks published in the Infobip platform OpenAPI 3.1 document (the "webhooks" object). Each channel is an Infobip-originated HTTP callback delivered to a customer-configured URL — delivery reports, inbound messages, conversation/calls events, tracking notifications and platform events. Derived by API Evangelist from the provider spec; message payloads $ref the schemas in that same document.
View Spec
View on GitHub
TelecommunicationsCroatiaCPaaSMessagingSMSVoiceRCSWhatsAppEmailNetwork APIsCAMARAOpen GatewayIdentity VerificationSIM SwapNumber VerificationOmnichannelAggregatorCustomer EngagementAsyncAPIWebhooksEvents
Channels
receive-test-message
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
cdp-event-webhook
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
conversation-event-webhook
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-sms-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-sms-message-reports-v3
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-sms-tracking-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-sms-message-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-mms-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-mms-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-mms-message-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-mms-tracking-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
calls-event-webhook
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-markup-language-instructions
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-markup-language-error
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-markup-language-record
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-markup-language-capture-dtmf
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
fetch-markup-language
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
send-machine-detection-callback
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
dial-callback
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
send-machine-detection-async-callback
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
send-machine-message-detection-async-callback
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
send-recording-status-callback
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-voice-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
deprecated-receive-voice-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-number-masking-target
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-masked-call-report
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-url-destination-request
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
call-link-status-webhook
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-email
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-email-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-email-tracking-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-email-platform-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-whatsapp-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-whatsapp-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-whatsapp-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-whatsapp-payment-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-whatsapp-marketing-update-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-whatsapp-message-template-update-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-whatsapp-identity-change-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-viber-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-viber-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-viber-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-viber-bot-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-viber-bot-api-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-line-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-zalo-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-zalo-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-push-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-rcs-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
inbound-events-receive-inbound-rcs-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-typing-indicator-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-rcs-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-conversation-started-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-capability-check-result
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-sender-update-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-sender-launch-update-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-test-number-update-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-rcs-message-template-update-events
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-omni-failover-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-omni-failover-message-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-omni-failover-inbound-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-livechat-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-apple-mfb-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messages-apple-mfb-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-instagram-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-instagram-api-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-messenger-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messenger-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messenger-marketing-click
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messenger-api-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messenger-consent-update
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-kakao-alim-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-kakao-sangdam-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-kakao-sangdam-api-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-kakao-chingu-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-open-channel-outbound-message
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-outbound-tiktok-message-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-tiktok-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-inbound-tiktok-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
brand-registration-status-change-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
brand-auth-2fa-update-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
brand-vet-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
campaign-network-status-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
campaign-status-change-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
campaign-ai-feedback-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
campaign-ai-builder-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-aggregate-data-result
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-billing-usage-result
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-blocklist-event
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messages-api-delivery-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messages-api-seen-reports
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-messages-api-incoming-messages
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
resource-request-status-change-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
resource-request-reminder-notification
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-silent-mobile-verification-result
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-advanced-silent-mobile-verification-result
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-number-intelligence-query-results
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-extraction-session-results
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-kyc-session-results
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-enrollment-session-results
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
receive-verification-session-results
Delivered by Infobip to the customer-configured webhook URL (notifyUrl / subscription endpoint) via HTTP POST.
Messages
receive-test-message-message
Receive testing message
Incoming test messages will be forwarded to this endpoint. For now supported channels are WhatsApp, Live Chat and Calls.
cdp-event-webhook-message
People Webhook
Webhook triggered when there is any new event on platform that your application should handle.
conversation-event-webhook-message
Conversations Webhook
Webhooks are automated notifications sent between applications when specific events occur. They enable real-time communication by transmitting data through HTTP requests. Conversations webhooks provide instant access to conversation details and the latest message information, a
receive-inbound-sms-messages-message
Receive inbound SMS messages
Receive SMS messages from your subscribers and have them delivered to you in real-time. To use this method, you’d need to:
- Buy a number capable of receiving SMS traffic.
- S
receive-outbound-sms-message-reports-v3-message
Receive outbound SMS message reports
For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint URL using the webhooks > delivery > url parameter. Alternatively, you can set the endpoint URL t
receive-sms-tracking-notification-message
Receive SMS tracking notifications
For every message you send, we offer the option to send you clicked events. To enable this feature, you need to specify your endpoint URL either in the [tracking](https://www.infobip.com/docs/api/channels/sms/outbound-sms/send-sms-messages) or [urlOptions](https://www.infobip.com
receive-outbound-sms-message-reports-message
Receive outbound SMS message report
For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint [when sending SMS](#programmable-communications/sms/send-sms-message). Alternatively, you can se
receive-inbound-mms-messages-message
Receive inbound MMS messages
If you want to receive MMS messages from your subscribers we can have them delivered to you in real time. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number by specifying your endpoint and we will
receive-outbound-mms-message-delivery-reports-message
Receive MMS delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-outbound-mms-message-reports-message
Receive outbound MMS message report
For each MMS that you send out, we can send you a message delivery report. All you need to do is specify your endpoint [when sending MMS](#programmable-communications/mms/send-sms-message) and we will deliver a [status](https://www.infobip.com/docs/essentials/response-status-and-
receive-mms-tracking-notification-message
Receive MMS tracking notifications
For every message you send, we offer the option to send you clicked events. To enable this feature, you need to specify your endpoint URL in [tracking](https://www.infobip.com/docs/api/channels/mms/send-mms-messages) parameters when sending the MMS, or alternatively, configure it
calls-event-webhook-message
Event Webhook
Webhook triggered when there is any new event on platform that your application should handle.
receive-markup-language-instructions-message
Markup callback API
Upon receiving a call to the Calls Markup Language, the Infobip platform generates a request to the **markupUrl** you set up in the Markup Language configuration. This request will contain Markup Language instructions which dictates call flow.
receive-markup-language-error-message
Error callback API
When the Infobip platform fails to retrieve or execute Markup Language instructions, it generates a request to the **errorUrl** you set up in the Markup Language configuration. The request carries the call context together with the error code and details that describe the failu
receive-markup-language-record-message
Record callback API
When the Infobip platform stops a call recording produced by a Record instruction, it generates a request to the callback URL configured on that Record instruction. The request carries the call context together with the recorded file identifier and the current recording status.
receive-markup-language-capture-dtmf-message
Capture DTMF callback API
When the Infobip platform finishes collecting DTMF input requested by a CaptureDtmf instruction, it generates a request to the callback URL configured on that CaptureDtmf instruction. The request carries the call context together with the captured DTMF sequence.
fetch-markup-language-message
Fetch callback API
When the Infobip platform executes a Fetch instruction, it generates a request to the **url** you set up in the Fetch instruction. The request carries the call context together with the fetch instruction details.
send-machine-detection-callback-message
Machine detection callback API
When the Infobip platform finishes machine detection requested by a MachineDetection instruction, it generates a request to the callback URL configured on Markup Language configuration (markupUrl). The request carries the call context together with the machine detection result.
dial-callback-message
Dial callback API
When the Infobip platform finishes processing a dial endpoint requested by a Dial instruction, it generates a request to the callback URL configured on that Dial instruction. The request carries the call context together with the dial endpoint result.
send-machine-detection-async-callback-message
Machine detection async callback API
When the Infobip platform finishes machine detection requested by a MachineDetection instruction, it generates a request to the callback URL configured on Markup Language configuration (markupUrl). The request carries the call context together with the machine detection result.
send-machine-message-detection-async-callback-message
Machine message detection callback API
When the Infobip platform finishes machine message detection requested by a MachineMessageDetection instruction, it generates a request to the callback URL configured on Markup Language configuration (markupUrl) The request carries the call context together with the machine mes
send-recording-status-callback-message
Recording status callback API
When the Infobip platform finishes processing a recording requested by a Record instruction, it generates a request to the callback URL configured on Record or StartRecording instruction. The request carries the call context together with the recording status.
receive-voice-delivery-reports-message
Receive Voice Delivery Reports
We can send you delivery reports for Voice messages, outbound IVR, Click-to-call or Markup Language in real time. All you need to do is specify notifyUrl in your endpoint when using some of these features and we will deliver a [status](https://www.infobip.com/docs/essentials/resp
deprecated-receive-voice-delivery-reports-message
Receive Voice Delivery Reports
This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.
We strongly advise you to update to new [delivery report method](#programmable-communications/voice/receive-voice-delivery-reports).
We strongly advise you to update to new [delivery report method](#programmable-communications/voice/receive-voice-delivery-reports).
receive-number-masking-target-message
Number Masking callback API
Upon receiving a call to the Number Masking number, Infobip platform generates a request to the **callbackUrl** you set up in the NM configuration. This request will contain the callee number and the Voice number that's called. We also provide **correlationID** and **nmCorrelat
receive-masked-call-report-message
Number Masking status API
After a received call to the Number Masking number has finished, Infobip platform generates a request to your **statusURL** set up in the NM configuration. This request contains report details of the call. We also provide the **correlationID** and **nmCorrelationID** to be used
receive-url-destination-request-message
URL destination webhook
The client-defined API is triggered with information about the current call whenever the URL destination is reached in route resolution. The expected response is a valid endpoint destination.
call-link-status-webhook-message
Call Link Webhook
Webhook event payload that will be delivered on the url defined in the call link configuration.
receive-inbound-email-message
Receive parsed emails
To enable the receipt of incoming emails using Infobip, please contact your Account Manager for detailed instructions on activating this feature. Once enabled, follow the steps outlined in our [Get Started guide](https://www.infobip.com/docs/email/get-started#inbound-parsing) to
receive-email-delivery-reports-message
Receive email delivery reports
Here you can configure an endpoint via the `notifyUrl` parameter that will receive a delivery report each time an email is sent out. Alternatively, you can also provide the endpoint’s URL to Customer support and they will set it up for you.
receive-email-tracking-reports-message
Receive user events
For each email that you send out, we can send you a tracking report for opened, clicked, complained, late bounce and unsubscribed. All you need to do is specify your endpoint [when sending email](https://www.infobip.com/docs/api/channels/email/send-fully-featured-email) and we wi
receive-email-platform-events-message
Receive email platform events
Receive platform-level events related to your email sending configuration. Events are delivered as they occur, with the `type` field inside `eventDetails` indicating the specific event. Learn more about [bounce rates](https://www.infobip.com/docs/email/email-deliverability#bounce
receive-inbound-whatsapp-messages-message
Receive WhatsApp inbound message
Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number by
receive-whatsapp-delivery-reports-message
Receive delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer Support and they will set it up for you. Once the setup is complete, we will be able to de
receive-whatsapp-seen-reports-message
Receive seen reports
For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer Support and they will set it up for you. Once the setup is complete, we will be able to delive
receive-whatsapp-payment-notification-message
Receive WhatsApp Payment Notification
Receive notification about payment transaction updates.
receive-whatsapp-marketing-update-notification-message
Receive WhatsApp Marketing Update Notification
Receive notification about user preferences for marketing template messages.
receive-whatsapp-message-template-update-events-message
Receive WhatsApp template update
For each message template you create, we can send you updates. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.
receive-whatsapp-identity-change-notification-message
Receive WhatsApp Identity Change Notification
Receive notification about end user's identity change. Feature is not enabled by default.
receive-inbound-viber-messages-message
Receive Viber inbound message
Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint provided during the account setup.
receive-outbound-viber-message-delivery-reports-message
Receive Viber delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-viber-seen-reports-message
Receive seen reports
For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each
receive-outbound-viber-bot-message-delivery-reports-message
Receive Viber Bot delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-viber-bot-api-incoming-messages-message
Receive incoming message
Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com
receive-outbound-line-message-delivery-reports-message
Receive LON delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-zalo-incoming-messages-message
Receive incoming message
Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com
receive-outbound-zalo-delivery-reports-message
Receive delivery reports
Incoming Reports will be forwarded to this endpoint. Please specify the endpoint’s URL for each message via the webhooks > delivery > url parameter. Alternatively you can provide the endpoint’s URL to [Customer Support](support@infobip.com) and they will set it up for you. Contac
receive-outbound-push-message-delivery-reports-message
Receive Push delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-inbound-rcs-messages-message
Receive RCS inbound message
Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint provided during the account setup.
inbound-events-receive-inbound-rcs-events-message
Receive RCS user action event
Set up logic for processing incoming events to customize two-way communication. Inbound events are forwarded in real time to the endpoint provided during the account setup.
receive-rcs-typing-indicator-events-message
Receive RCS typing indicator event
Set up logic for processing incoming typing indicator events to customize two-way communication. Inbound events are forwarded in real time to the endpoint provided during the account setup.
receive-outbound-rcs-message-delivery-reports-message
Receive RCS delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-rcs-seen-reports-message
Receive seen reports
For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each
receive-rcs-conversation-started-events-message
Receive RCS conversation started event
Webhook notifying that a message's billing model changed from non-conversational to conversational.
receive-capability-check-result-message
Receive Capability Check result
Receive the results requested by [Check RCS capability (async)](#channels/rcs/capability-check-rcs-destinations-notify). This callback will be invoked once per each phone number with POST method.
receive-rcs-sender-update-events-message
Receive an RCS sender update event
Any time you request some operation to be executed for RCS sender, that operation will be executed asynchronously. After operation is executed, an event is sent. Also, some operations for RCS sender can be executed by Infobip team (e.g. launching a
receive-rcs-sender-launch-update-events-message
Receive an RCS sender launch update event
When a launch request is submitted for a given RCS sender, the launch status is updated individually for each provider within the selected country. This webhook delivers real-time updates whenever the launch status changes for any provider in any c
receive-rcs-test-number-update-events-message
Receive an RCS test number update event
Any time you request some operation to be executed for RCS test number, that operation will be executed asynchronously. After operation is executed, an event is sent. Also, status of test number could be changed as a result of end user action (e.g.
receive-rcs-message-template-update-events-message
Receive an RCS template update
For each message template you create, we can send you updates. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info. Availab
receive-omni-failover-message-delivery-reports-message
Receive delivery status report
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Once the setup is complete, we will be able t
receive-omni-failover-message-seen-reports-message
Receive seen reports
For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Once the setup is complete, we will be able to de
receive-omni-failover-inbound-messages-message
Receive incoming message
Incoming messages will be forwarded in real time to the end-point client provided during the setup. This way, 2-way communication will be established, and the enterprise is enabled to create a certain logic for processing incoming messages.
receive-inbound-livechat-messages-message
Receive Livechat inbound messages
Set up the logic for processing incoming messages to enable customized two-way communication. Inbound messages will be forwarded in real-time to the specified endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-config
receive-outbound-apple-mfb-message-delivery-reports-message
Receive Apple Messages for Business delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-messages-apple-mfb-incoming-messages-message
Receive incoming message
Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com
receive-outbound-instagram-message-delivery-reports-message
Receive Instagram delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-instagram-api-incoming-messages-message
Receive incoming message
Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com
receive-outbound-messenger-message-delivery-reports-message
Receive Messenger delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-messenger-seen-reports-message
Receive seen reports
For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each
receive-messenger-marketing-click-message
Receive Messenger Marketing Click event
Event is sent when a person clicks a Marketing Message. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.
receive-messenger-api-incoming-messages-message
Receive incoming message
Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com
receive-messenger-consent-update-message
Receive Messenger consent update event
Event is sent when the person opts in or opts out of Marketing Messages. The `event` field indicates the type: `SUBSCRIBE` for opt-in, `UNSUBSCRIBE` for opt-out. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs
receive-outbound-kakao-alim-message-delivery-reports-message
Receive Kakao Alim delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-outbound-kakao-sangdam-message-delivery-reports-message
Receive Kakao Sangdam delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-kakao-sangdam-api-incoming-messages-message
Receive incoming message
Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com
receive-outbound-kakao-chingu-message-delivery-reports-message
Receive brand message delivery reports
For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’
receive-open-channel-outbound-message-message
Receive Open Channel outbound Message
Set up logic for processing outbound messages to customize two-way communication. Outbound messages are forwarded in real time to the endpoint provided during the account setup.
receive-outbound-tiktok-message-delivery-reports-message
Receive TikTok delivery reports
Use this webhook to receive delivery reports for outbound TikTok messages. To receive delivery reports, configure the webhook URL for each message by using the `webhooks > delivery > url` parameter. Alternatively, contact [Support](mailto:support@infobip.com) to configure the web
receive-tiktok-seen-reports-message
Receive TikTok seen reports
Use this webhook to receive seen reports for outbound TikTok messages. To receive seen reports, configure the webhook URL for each message by using the `webhooks > seen > url` parameter. Alternatively, contact [Support](mailto:support@infobip.com) to configure the webhook URL for
receive-inbound-tiktok-messages-message
Receive an inbound TikTok message
Use this webhook to receive inbound TikTok messages in real time. Infobip forwards messages to the webhook URL configured during account setup, so you can process them and continue two-way conversations. The default format for inbound TikTok messages is `MO_OTT_MSISDN`.
brand-registration-status-change-notification-message
Receive Brand Status Update
Any time brand registration is completed or failed, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_STATUS_UPDATE' event.
brand-auth-2fa-update-notification-message
Receive Brand Auth 2FA Update
Any time brand 2FA email is sent or authentication is completed, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_AUTH_UPDATE' event.
brand-vet-notification-message
Receive Brand Vet Update
Any time a brand vet is completed or failed, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_VET_UPDATE' event.
campaign-network-status-notification-message
Receive Campaign Network Status Update
Any time a campaign changes status on carrier side, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'CAMPAIGN_NETWORK_STATUS_UPDATE' event.
campaign-status-change-notification-message
Receive Campaign Status Update
Any time campaign status is changed, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'CAMPAIGN_STATUS_UPDATE' event.
campaign-ai-feedback-notification-message
Receive AI Campaign Feedback
Any time a campaign AI review is finished and ready for the results to be fetched, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'AI_CAMPAIGN_FEEDBACK' event.
campaign-ai-builder-notification-message
Receive AI Campaign Builder Completion Notification
Any time a campaign AI builder job is finished and ready for the results to be fetched, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'AI_CAMPAIGN_BUILDER' event.
receive-aggregate-data-result-message
Receive aggregated data result
Receive data response, requested by [Query aggregate traffic data](#platform/metrics-api/query-aggregate-data). This callback will be invoked only once with POST method.
receive-billing-usage-result-message
Receive billing usage result
Receives data response requested by the [Query billing usage data](#platform/billing-usage/query-billing-usage) endpoint. This webhook is called once via POST when the query completes.
receive-blocklist-event-message
Receive blocklist event
Anytime a blocklist is added or removed by an end-user action or within the campaign, an event is sent. You need to subscribe to this event using the 'BLOCKLIST' channel, and specify the 'BLOCK' and 'UNBLOCK' events. For more details, see [documentation](https://www.infobip.com/d
receive-messages-api-delivery-reports-message
Receive delivery reports
Incoming Reports will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com i
receive-messages-api-seen-reports-message
Receive Seen reports
Incoming Seen Reports will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com
receive-messages-api-incoming-messages-message
Receive inbound messages
Incoming messages will be forwarded to this endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number or resource by specifying your endpoint and we will send inbound messages to you as soon as
resource-request-status-change-notification-message
Receive resource request status update
Any time resource request status is changed, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'RESOURCE_REQUEST_STATUS_UPDATE' event.
resource-request-reminder-notification-message
Receive resource request reminder
When a resource request requires an update and remains inactive, reminder events are sent at 3, 15 and 27 days of inactivity. After 30 days, the request is automatically rejected. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'RESOURCE_REQUEST_R
receive-silent-mobile-verification-result-message
Receive silent mobile verification result
Silent mobile verification request will be processed asynchronously after the request is made to silent mobile verification API. After processing of the request is done, results will be delivered to the URL provided in silent mobile verification request.
receive-advanced-silent-mobile-verification-result-message
Receive advanced silent mobile verification result
Advanced silent mobile verification request will be processed asynchronously after the request is made to advanced silent mobile verification API. After processing of the request is done, results will be delivered to the URL provided in advanced silent mobile verification request
receive-number-intelligence-query-results-message
Receive number intelligence query results
Number intelligence query request will be processed asynchronously after the request is made to number intelligence API. After processing of the request is done, results will be delivered to the URL provided in number intelligence request.
receive-extraction-session-results-message
Receive Extraction Session Results
Webhook that will be called with information about the Extraction Session status and results. The webhook URL provided in the [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) request will be called with the POST method that conta
receive-kyc-session-results-message
Receive KYC Session Results
Webhook which will be called with information about the KYC session status and results. The webhook URL provided in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) request will be called with the POST method that contains all the info in
receive-enrollment-session-results-message
Receive Enrollment Session Results
Webhook that will be called with information about the Enrollment Session status and results. The webhook URL provided in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) request will be called with the POST method that conta
receive-verification-session-results-message
Receive Verification Session Results
Webhook which will be called with information about the Verification session status and results. The webhook URL provided in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) request will be called with the POST method tha