How to setup sms api webhook

Kamta — Wed, 02 Oct 2024 07:16:46 GMT

Is there way to set up webhook for sms api so when a message is delivered or a user replies back to sms the webhook triggers.

I have setup a webhook in conversation api sms channel but it is not triggering.

Re: How to setup sms api webhook

Sam_Williams — Wed, 02 Oct 2024 21:54:25 GMT

Hello, thank you for reaching out!

If the webhook you set up for your Conversation API app isn't behaving as expected, you may need to review the triggers you configured for it. For the two cases you described in your original post, ensure that your webhook is configured for (at least) the following triggers:

MESSAGE_DELIVERY, which will deliver delivery receipts for messages sent by your Conversation API app.
MESSAGE_INBOUND, which will deliver inbound messages sent by end users on the underlying Conversation API channels (including the SMS channel).

You can assign up to five webhooks to a single Conversation API app, and each of those webhooks may be configured for multiple triggers.

Note: These instructions are for the SMS channel of the Conversation API. If you are using the standalone SMS API, you'll configure your callbacks using a different method.

Additional Troubleshooting

If you are still having issues after reviewing your webhook triggers, ensure that the SMS channel of your Conversation API app is configured correctly. Specifically, you can review the DEFAULT CALLBACK URL associated with the Service API assigned to the SMS channel of your Conversation API app. To review this URL:

Log in to the Sinch Customer Dashboard.
Select Conversation API from the left Communication APIs menu and select the Apps option.
Click the name of your app.
Locate the SMS entry in the Set up channels section. Note the corresponding Service Plan ID.
Select SMS from the left Communication APIs menu and select the Service APIs option.
Locate the row that corresponds to the Service Plan ID you noted in step 4.
Ensure that the DEFAULT CALLBACK URL is configured for use with the Conversation API (that is, ensure it is a Sinch adapter URL).

If the criteria described in step 7 is not met, consider either creating a new Service API for use with your Conversation API app or updating the DEFAULT CALLBACK URL of the existing Service API. Consult with your Account Manager to ensure that any configuration updates do not result in a loss of productivity with your solution.

Warning: If you wish to update the DEFAULT CALLBACK URL of the existing plan, you must first remove the current URL. This may may interrupt the flow of incoming traffic into your solution. Consult with your Account Manager prior to updating any existing DEFAULT CALLBACK URL fields.

If you decide to complete one of the options described in step 8, complete that process. You must then reconfigure the SMS channel of your Conversation API app:
1. Select Conversation API from the left Communication APIs menu and select the Apps option.
2. Click the name of your app.
3. Click the SMS entry in the Set up channels section.
4. Click RESET INTEGRATION and confirm your choice.
5. Click the SMS entry in the Set up channels section again and configure the channel, ensuring that you select the Service Plan ID that is to be used with this Conversation API app.

Please let us know if you continue to have any issues, or if you have any other questions. Also, if there is additional information you'd like to provide regarding this issue, feel free to do so by adding a post to this thread or sending me a direct message.

Thank you again for reaching out!

topic How to setup sms api webhook in Developer Forum

How to setup sms api webhook

Re: How to setup sms api webhook

Additional Troubleshooting