Webhooks

This topic describes how to create webhooks in the Rebilly UI. For information on how to use webhooks with the Rebilly API, see Webhook configuration.

Use webhooks to notify your systems when certain events occur and to collect event information.

Create a webhook

Use this process to create and define new webhooks.

  1. In the left navigation bar, click automation icon Automations .
  2. In the Development section , click Webhooks , then click Create webhook .
  3. In the ID field, enter an ID for the webhook.
  4. In the Status section, to activate or deactivate the webhook, turn on or off the toggle.
  5. In the Events section, select Send specific event types .
  6. In the Events filter dropdown, select the event or events that you want to associate with the webhook.
  7. Optionally, to define conditions for when the webhook is sent: In the Conditions section, clear the No conditions checkbox, then add one or more filters.
    Note: If the No conditions checkbox is selected, the webhook is sent for all events that are selected in the Events section.
  8. In the Endpoint section, in the Webhook URL field, specify the HTTP method and URL for your endpoint.
  9. Select from the following:
    • Specify authorization type: Click Authorization .
    • Define or add headers: Click Headers , then click Add header to specify header value.
    • Specify custom webhook bodies: Click Body , clear the Use default event payload checkbox, then specify the payout body.
  10. Click Test webhook .
  11. Click Save webhook .

Edit a webhook

Use this process to edit or reconfigure an existing webhook.

  1. In the left navigation bar, click automation icon Automations .
  2. In the Development section , click Webhooks , then click Create webhook .
  3. In the list of webhooks, under the ID column, click the ID of the webhook that you want to edit.
  4. Edit the webhook, then click Save webhook .

Activate or deactivate a webhook

Use this process to activate or deactivate an existing webhook.

  1. In the left navigation bar, click automation icon Automations .
  2. In the Development section , click Webhooks , then click Create webhook .
  3. In the list of webhooks, under the ID column, click the ID of the webhook that you want to activate or deactivate.
  4. In the Status section, turn the toggle on or off to activate or deactivate the webhook.

Test a webhook

Use this process to test an existing webhook.

  1. In the left navigation bar, click automation icon Automations .
  2. In the Development section , click Webhooks .
  3. In the list of webhooks, on the right of a webhook, click Test webhook .