Skip to main content

Creating Webhooks

Webhooks require three elements to function:

  1. Webhooks can be set up and managed from Settings » Webhooks in your dashboard or programatically using the KIRI Engine API.

  2. Callback URL

    This is the URL where KIRI Engine will sent a POST request when a model's status changes.

  3. Signing secret

    This is a secret (typically a random string) between 6 and 40 characters used to sign each request. You should validate each incoming webhook against this secret to verify that the request came from KIRI.

Important Notes:

1. Please make sure the NotifyUrl can be accessed.

2. Please make sure to use the POST method and JSON format to receive the 'status' and 'serialize' data.

3、Please return HTTP 200 to our server upon receiving the notification.