Platform OverviewIntegration HubConfiguration and Customisation
API Reference

configWebhook

post
https://api.sandbox.toq.io/toqio-webhooks/api/customers//webhook

Create or update the webhook configuration for a customer. Calling this endpoint again for a customer that already has a configuration overwrites the existing webhookUrl and webhookSecret.

Important: webhookUrl must be a full, absolute URL including the protocol (https:// is strongly recommended), for example https://example.com/webhooks. A value such as example.com/webhooks is not a valid URL: it is rejected with 400 Bad Request, and no notifications could be delivered to it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

DTO to create and update webhooks configuration

string
\S

The secret key to be used for authentication purposes

string
^https?://\S+$

The webhook URL where you will receive notifications. Must be an absolute URL that includes the protocol (https:// or http://) and the host, for example https://example.com/webhooks. A URL without the protocol (for example example.com/webhooks) is rejected with 400 Bad Request.

Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?