Use ActiveCampaign webhooks

Navigation: Main_Page > Developers > Webhooks > Use ActiveCampaign webhooks

Use ActiveCampaign Webhooks

ActiveCampaign allows you to utilize webhooks to send real-time updates regarding your contact and campaign activities to external sources. This capability is particularly beneficial for developers and businesses looking to keep their external systems synchronized with their ActiveCampaign data, thereby enhancing automation and integration across platforms.

Introduction

Webhooks are automated messages sent across the internet from one system to another in response to specific events. They serve as a means to send data instantly from your ActiveCampaign account to update an external database or application as contact, campaign, deal, or custom object activities occur. For instance, after updating a contact record, or when a new account is created, the webhook can trigger to send updated information to a designated external system.

ActiveCampaign offers two types of webhooks—Standard Object webhooks and Custom Object webhooks. The availability of these types depends on the ActiveCampaign plan you are subscribed to, offering flexible capabilities whether you use a more basic or higher-tier plan.

How to Access This Feature

To access the webhook feature in ActiveCampaign, navigate to the Settings menu within your account and select the Developer Settings option, or opt to create a webhook directly within an automation workflow.

Step-by-Step Instructions

Creating a Webhook under Developer Settings

Follow these steps to create a webhook in the Developer Settings:

1. Click on the Settings (gear icon) from the left sidebar.
2. Select Developer from the menu options.
3. Click on the Manage Webhooks button.
4. Click the Add button to initiate a new webhook creation.
5. A modal window will pop up; choose the type of webhook you wish to create.
6. Complete the following fields based on the webhook type selected:

  * **Standard Object Webhooks**:
    * Fill in the Name and URL fields. The URL determines where the webhook will post data when the specified event occurs.
    * From the Type dropdown, select the action or event that will trigger the webhook. You can choose multiple events.
    * Choose where the action(s) should initialize from (contact's action or account user's action).
    * Associate the webhook with a list if required, which appears only for specific webhook types.
    * Finally, click the Save button to finalize your webhook.
  
  * **App and Custom Webhooks**:
    * Provide a Name for your webhook.
    * In the Type dropdown, select the action or event triggering the webhook, with the option to select multiple events.
    * Enter the intended URL for the webhook to post data.
    * Click the Save button.
  
  * **Ecommerce Custom Object Webhooks**:
    * Name your webhook.
    * Specify the URL to post data.
    * Select the actions/events from the Events dropdown that will trigger the webhook, allowing for multiple selections.
    * Click the Save button.

Configuration Options and Settings

When configuring webhooks, keep in mind the following key aspects:

• **Webhook Types**:

  * There are two main types of webhooks: Standard Object and Custom Object.

• **Initiation Options**:

  * A webhook can be initiated by:
    * **Contact**: When a contact causes the action (e.g., opens a campaign).
    * **Any User**: When an administrator causes the action (e.g., adding a contact).
    * **System Processes**: When automated processes run the action (e.g., email bounces).
    * **API**: When the action is triggered through an API call (e.g., adding a contact using the contact_add API).

• **Data Transmission**:

  * The data sent via a webhook is transmitted as a POST parameter to the specified URL.

Best Practices and Tips

• Always ensure that the receiving application can process POST requests securely using HTTPS, as ActiveCampaign sends data exclusively over secure channels.
• Test your webhook using the Send Sample Data option on the Settings > Developer > Webhooks page before implementing it.
• Monitor webhook responses to ensure they are being received correctly. It’s wise to log errors to enable troubleshooting and ensure stable integration.
• Understand the limitations on customization for webhook payloads as they cannot be altered.

Common Use Cases with Examples

Webhooks are useful for various scenarios, such as:

• **Real-time data updates**: Automatically update an external CRM system every time a contact changes status or data in ActiveCampaign.
• **Ecommerce integrations**: Trigger actions in external ecommerce platforms when orders or products are created or modified in ActiveCampaign.
• **Event logging**: Capture user interactions in real-time for analytical purposes, allowing businesses to improve their marketing strategies.

Troubleshooting

• If your webhook fails to deliver data, check the receiving application's logs to confirm if the request was received.
• Ensure that the webhook URL is correctly entered and that the receiving server can process HTTPS requests.
• Validate that the response received from the external application is properly structured to handle the data being sent.

Related Features

• For further automation capabilities, consider exploring Automations which allows more complex workflows that may incorporate webhooks.
• Investigate the use of API integration for more advanced data management and synchronization needs.

FAQ

Q1: Can I customize the webhook payload? A1: No, ActiveCampaign does not support customizing webhook payloads.

Q2: Are webhooks secure? A2: Yes, webhooks are sent only via HTTPS, ensuring secure data transmission.

Q3: How do I test my webhook? A3: You can test your webhook by using the Send Sample Data button found in your webhook settings.

Q4: What types of webhooks does ActiveCampaign offer? A4: ActiveCampaign offers Standard Object and Custom Object webhooks based on your subscription plan.

Q5: Can I create webhooks for any event? A5: You can create webhooks for specific actions available within the ActiveCampaign platform, but not all events may support webhook triggers.

Q6: What happens if my webhook endpoint is down? A6: ActiveCampaign guarantees delivery at least once, which means there might be retries if the endpoint is unresponsive during the initial attempt.

Q7: How many webhooks can I create? A7: The platform may have limits depending on your plan; refer to your ActiveCampaign account specifics for details.

By following these guidelines and utilizing the ActiveCampaign webhook feature effectively, you can automate and enhance your workflows. For more information on using webhooks, visit the [ActiveCampaign API documentation](https://developers.activecampaign.com/page/webhooks).