Skip to main content
Version: 2.1.0

webhooks API

cidaas webhooks API

cidaas webhooks can be configured in the admin portal or by using the relevant API.

The webhook is called (triggered) when an event occurs for which the webhook has been registered.

A webhook can listen for multiple events. For this, the events have to be specified during the setup process.

Basically, no critical and personal data is provided with a webhook call.

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