Store Webhook Setup
POST/webhook-srv/webhooks
This API call creates or updates a webhook setup used to configure the Webhook.
A Webhook has to be secured with one of the following methods defined using the auth_type:
| Auth Type | Security Level | Description |
|---|---|---|
| APIKEY | low | The receiver's webhook endpoint must verify the pre-shared API key that is sent with each request. |
| TOTP | medium | The receiver's webhook endpoint must verify the time-based one-time password (TOTP) that is generated using the configured TOTP key and sent with each request. |
| CIDAAS_OAUTH2 | high | The receiver's webhook endpoint must accept OAuth2 tokens issued via the client credentials grant flow. The required scopes must be configured in the receiver's webhook service. |
Limitations:
- Up to 20 webhooks can be created.
- A webhook cannot have the same URL as another webhook.
- If webhooks share the same URL, they cannot overlap events across each other.
Request
Responses
- 200
- 201
- 400
- 401
OK
CREATED
BAD_REQUEST
UNAUTHORIZED