Skip to main content
POST
/
onboarding
/
configureWebhook
Configure Webhook
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/onboarding/configureWebhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "webhookUrl": "https://api.idcanopy.com/webhooks/onboarding",
  "metadata": {
    "authHeader": {
      "Authorization": "Bearer EXAMPLE_TOKEN_1234567890abcdef",
      "Api-Key": "fQVZSAp18GqvbwId8LotQl"
    }
  }
}'
{
  "status": true,
  "data": {
    "id": "74884fe3-c9e1-4462-b60f-c461e422000c",
    "url": "https://api.idcanopy.com/webhooks/onboarding",
    "createdAt": "2025-05-08T16:39:28.339Z"
  }
}
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 authentication header of the form Bearer <token>, where <token> is your auth token.

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