Skip to main content
Version: Latest (3.102.4)
Version: 2.1.0

Webhooks API

Webhooks in cidaas can be configured via the UI Portal or through the respective APIs.

A webhook can subscribe to multiple events. A full list of available events is provided here.

The webhook is triggered whenever a subscribed event occurs.

If a webhook delivery fails, it is retried up to 3 additional times at intervals of 1 minute, 5 minutes, and 10 minutes.

Authentication

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Scopes:

  • cidaas:webhook_read: The read access for the webhook

  • cidaas:webhook_write: The write access for the webhook

  • cidaas:webhook_delete: The delete access for the webhook

OAuth Flow (clientCredentials):

Scopes:

  • cidaas:webhook_read: The read access for the webhook

  • cidaas:webhook_write: The write access for the webhook

  • cidaas:webhook_delete: The delete access for the webhook

OAuth Flow (implicit):

Scopes:

  • cidaas:webhook_read: The read access for the webhook

  • cidaas:webhook_write: The write access for the webhook

  • cidaas:webhook_delete: The delete access for the webhook