Skip to main content
POST
Configure Webhook
For a usage description of the QES Onboarding Configure Webhook Service, please refer to the QES Onboarding page.

Endpoint

POST /onboarding/configureWebhook

Swagger

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json
webhookUrl
string<uri>
required

URL to receive status pings.

Example:

"https://api.idcanopy.com/webhooks/onboarding"

Response

Webhook successfully configured

status
boolean
required

Indicates if webhook was saved.

data
object
required