Webhooks

The use of webhooks is a provider-specific feature.

Important

The complete technical documentation of the webhook API and the corresponding data is available in ioki Platform API documentation. This article provides only an overview of what a webhook is and how it is set up.

A webhook is a method of communication between servers. In this case, it allows external systems to be informed when certain events occur in ioki Platform and to receive information about those events.

Unlike other APIs, this is an active mechanism: data is posted to a corresponding URL, whereas other APIs must be called by the external system.

As soon as a webhook is configured, specified events within ioki Platform trigger the creation of a webhook event. These events contain information about the corresponding product, the provider, the URL, and the event metadata that should be posted to that URL.

Webhook events

• A user has been created.
• A ride has been canceled.
• A vehicle planning was updated.

Webhook delivery is designed for high reliability. Delivery attempts are tracked, and failed attempts are retried. Repeated failures can cause a queue of undelivered webhooks to build up, which can put additional strain on the system. To manage this, a “circuit breaker” is used: if a specified number of webhooks fail within a defined timeframe, delivery attempts are paused temporarily until conditions improve. For more information about the available circuit-breaker settings, refer to the section Circuit breaker settings.

Activate this feature

Roles: Super Admin

1. Navigate to the management settings of the provider.
2. Within the Provider features section, select the checkbox Webhooks.
3. Select Save.

The admin procedure for this feature is documented in Webhooks in Control Center.