Skip to main content

Registering and Enabling Webhooks

Webhook handlers are manually registered in the "Service Providers" page of the Product Administrator. The instructions are in the guide Adding A Service Provider

Next the webhook handlers must programmatically enable their capabilities. The enabling should be done when the service-provider has completed its start-up and is ready to handle webhook requests. The REST API supports two approaches to enabling capabilities: a bulk operation to register and enable multiple capabilities or individual operations to register and enable or disable a capability.

In most situations, the bulk operation to register and enable capabilities will be easier to utilize. By selecting a different behavior, this bulk operation can also be used to disable capabilities during its graceful shutdown.

info

When the service provider in enabled and service provider has registered and enabled at least one capability, the health check mechanism will be automatically activated.