article How to add a webhook to a Conversation API app in Conversation API

article How to add a webhook to a Conversation API app in Conversation API https://community.sinch.com/t5/Conversation-API/How-to-add-a-webhook-to-a-Conversation-API-app/ta-p/8100 <DIV class="lia-message-template-content-zone"> <P>The Conversation API delivers contact messages, delivery receipts for app messages and various notifications through callbacks. You can create up-to 5 endpoints (webhooks) per conversation API app through the <A href="https://dashboard.sinch.com/convapi/apps" target="_blank" rel="noopener">Sinch Customer Dashboard</A> or by using the <SPAN>/webhooks</SPAN> <A href="https://developers.sinch.com/docs/conversation/callbacks/#webhook-management" target="_blank" rel="noopener">management endpoint</A>.</P> <P> </P> <P>To add a new webhook to your Conversation API app:</P> <P> </P> <OL> <LI>Log in to the <A href="https://dashboard.sinch.com/dashboard" target="_blank" rel="noopener">Sinch Customer Dashboard</A>.<BR /><BR /></LI> <LI>Select <STRONG>Conversation API</STRONG> from the left menu and select the <STRONG><A href="https://dashboard.sinch.com/convapi/apps" target="_blank" rel="noopener">Apps</A></STRONG> option. The Conversation Apps page is displayed.<BR /><BR /></LI> <LI>Click the name of the app to which you want to add the webhook. For example, click <STRONG>TestApp</STRONG>. The TestApp setup page is displayed. Scroll down to the <STRONG>Webhooks</STRONG> section:<BR /><BR /><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="Alex_Sberna_0-1631652072879.png" style="width: 999px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/1220iAC37BAF8A9E57FED/image-size/large?v=v2&px=999" role="button" title="Alex_Sberna_0-1631652072879.png" alt="Alex_Sberna_0-1631652072879.png" /></span> <P> </P> <STRONG>Note:</STRONG> If you do not already have a Conversation API App – click <A href="https://community.sinch.com/t5/Conversation-API/How-to-create-a-Conversation-API-App/ta-p/8069" target="_blank" rel="noopener">here</A> to learn how to create one.<BR /><BR /></LI> <LI>Click <STRONG>ADD WEBHOOK</STRONG>. The <STRONG>New webhook</STRONG> dialog box is displayed:<BR /><BR /><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="conversation_new_webhook.png" style="width: 400px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/5851i1ECE19A12ABE4AE0/image-size/medium?v=v2&px=400" role="button" title="conversation_new_webhook.png" alt="conversation_new_webhook.png" /></span><BR /><BR /></LI> <LI>In the <STRONG style="font-family: inherit;">Target type</STRONG><SPAN> drop-down, select HTTP.<BR /><BR /></SPAN></LI> <LI>In the <STRONG style="font-family: inherit;">Target URL</STRONG><SPAN> field, enter the URL to which you want the webhook to point.<BR /><BR /></SPAN></LI> <LI>If you want the webhook to validate against your chosen endpoint <A title="using HMAC" href="https://developers.sinch.com/docs/conversation/callbacks/#validating-callbacks" target="_blank" rel="noopener">using HMAC</A>, <SPAN>enter the token you want the webhook to use </SPAN>in the <STRONG style="font-family: inherit;">Secret token</STRONG><SPAN> field.<BR /><BR /><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="conversation_new_webhook_secret_token.png" style="width: 400px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/5852i96EA1381BADC7E61/image-size/medium?v=v2&px=400" role="button" title="conversation_new_webhook_secret_token.png" alt="conversation_new_webhook_secret_token.png" /></span><BR /><BR /></SPAN></LI> <LI>Select all the triggers you want to add to the webhook, in the <STRONG>Triggers</STRONG> down-down:<BR /><BR /><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="conversation_new_webhook_triggers.png" style="width: 372px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/5850i2F39F7AFD3EC6628/image-dimensions/372x436?v=v2" width="372" height="436" role="button" title="conversation_new_webhook_triggers.png" alt="conversation_new_webhook_triggers.png" /></span><BR /><BR />For more information about the kinds of information and events the triggers can return, see the <A style="font-family: inherit; background-color: #ffffff;" href="https://developers.sinch.com/docs/conversation/callbacks/#webhook-triggers" target="_blank" rel="noopener">webhook triggers</A><SPAN> documentation.<BR /><BR /></SPAN></LI> <LI><SPAN>To configure OAuth2.0 authentication, click the button under <STRONG>Enable OAuth2 authentication</STRONG>. Populate the <STRONG>Client ID</STRONG>, <STRONG>Client secret</STRONG>, and <STRONG>Token endpoint</STRONG> fields with the credentials Sinch will use to authenticate against the OAuth token-provision endpoint.<BR /></SPAN><SPAN><BR /><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="conversation_new_webhook_oauth2.png" style="width: 378px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/5847i8D3EE47BCFCDD3CB/image-dimensions/378x444?v=v2" width="378" height="444" role="button" title="conversation_new_webhook_oauth2.png" alt="conversation_new_webhook_oauth2.png" /></span><BR /><BR /></SPAN></LI> <LI>Click <STRONG style="font-family: inherit;">Create</STRONG><SPAN> to add the webhook.<BR /><BR /><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="conversation_new_webhook_create.png" style="width: 380px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/5848iE406D5258AFF9AFE/image-dimensions/380x446?v=v2" width="380" height="446" role="button" title="conversation_new_webhook_create.png" alt="conversation_new_webhook_create.png" /></span><BR /><BR /></SPAN></LI> <LI>The webhook is created and is displayed in the <STRONG style="font-family: inherit;">Webhooks</STRONG><SPAN> section of the app page.<BR /><BR /></SPAN><span class="lia-inline-image-display-wrapper lia-image-align-inline" image-alt="Alex_Sberna_4-1631652072889.png" style="width: 999px;"><img src="https://community.sinch.com/t5/image/serverpage/image-id/1223i4F8ED69522C470FE/image-size/large?v=v2&px=999" role="button" title="Alex_Sberna_4-1631652072889.png" alt="Alex_Sberna_4-1631652072889.png" /></span></LI> </OL> <P> </P> </DIV> Thu, 21 Nov 2024 07:00:59 GMT Alex_Sberna 2024-11-21T07:00:59Z How to add a webhook to a Conversation API app https://community.sinch.com/t5/Conversation-API/How-to-add-a-webhook-to-a-Conversation-API-app/ta-p/8100 <P>Next Steps:</P> <UL> <LI><A href="https://preview.redoc.ly/bumblebee/getting-started-revamp/docs/conversation/getting-started/node/incoming-message/" target="_blank" rel="noopener">Learn how to respond to messages sent using your webhook</A>.</LI> </UL> Thu, 21 Nov 2024 07:00:59 GMT https://community.sinch.com/t5/Conversation-API/How-to-add-a-webhook-to-a-Conversation-API-app/ta-p/8100 Alex_Sberna 2024-11-21T07:00:59Z