Aimfox Webhooks beta

Introduction

Webhooks (or HTTP callbacks) can be used to notify your systems about events as they occur in your Aimfox workspace. Using the Aimfox dashboard, you can setup several webhook endpoints to be notified of such events.

Configure Webhooks

To configure your webhooks, go to Worskspace settings. Then switch to the Webhooks tab.

If you have not added a webhook already, click Add webhook.

Adding a Webhook

Upon selecting Add webhook, a configuration dialog will appear. Please provide the following required information:

• Name (for identification purposes)
• URL (endpoint where webhook data will be sent)
• Authentication Header
  Optional security measure to authenticate webhook requests. You can use Basic Auth or custom headers like Bearer tokens.

For Basic Authentication, you can generate the header value using:
https://www.debugbear.com/basic-auth-header-generator

In the event selection dropdown, specify which events should trigger this webhook. Multiple event types can be selected for a single webhook endpoint. Complete the configuration by selecting Save.

Automatic Retries

Webhook execution can fail due to timeouts or errors. For each event whose webhook call fails, the calls are retried up to 6 times based on the following schedules:

Retry	Time
1	1 minute after the failure
2	5 minutes after the previous retry
3	30 minutes after the previous retry
4	1 hour after the previous retry
5	6 hours after the previous retry
6	1 day after the previous retry

Events

For every event you will receive a webhook with following fields:

• id
  A unique identifier for the event
• events_type
  The type of the event
• workspace
  Object containing the workspace details
• event
  Object containing details about the event, specific to the event type

Below is the list of events that can be triggered including their description and an example payload: