Skip to main content

Webhooks

How to implement webhooks and listen to Aimfox events

Written by Managers

Webhooks (or HTTP callbacks) are used to notify your system about events as they happen in your Aimfox workspace.

Webhooks can be used to setup advanced workflows based on Aimfox events like getting a new connection, reply to your campaigns, account logins / logouts, and more.

You can find our developer documentation for webhooks here: https://docs.aimfox.com/webhooks

Setting up webhooks:

Webhooks can be configured in the "Webhooks" tab of your Workspace settings. To access this tab, log in to your Aimfox account and navigate to the Workspace Settings section.

Adding a webhook:

Click the "Add webhook" button (screenshot below) to add your first webhook. This will open a popup asking you to configure the following:

  • Name

  • This identifies the webhook.

  • URL

  • This is the endpoint where webhook data will be sent.

  • Authentication Header

  • This is an optional security measure for authenticating webhook requests. You can use Basic Auth or custom headers, such as Bearer tokens.

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

  • Select webhook events:

  • You must specify which events should trigger the webhook. You can select multiple events for a single webhook endpoint, and you must select at least one event to create a webhook.

    • For example, select the new_reply event to receive notifications whenever a reply is received for messages sent from any account in your workspace.

Complete the configuration by selecting Save.

Managing webhooks

You can change the configuration for any of your webhooks at any time by clicking "Edit webhook" in the 3 dots dropdown menu. You can also delete or test them by selecting the "Delete webhook" or "Test webhook" option.

If you need any further information about webhooks or their implementation, contact our team on the live chat. We will be happy to answer all of your questions.


Did this answer your question?