Skip to main content
All CollectionsCampaigns
Webhook Integration
Webhook Integration
Updated over a month ago

Overview

We are thrilled to introduce a new infrastructure for forwarding events from our system to your subscribed endpoints! πŸŽ‰βœ¨ This feature allows seamless integration of our system's events into your workflows, offering enhanced product-level customization and security through Basic Authentication.


Key Features

1. Event Forwarding

You can now receive event notifications in real-time based on your subscription. Supported events include:

  • Sent

  • Delivered

  • Read

  • Failed

These events will be forwarded to your designated endpoint, ensuring timely updates.


2. Product-Level Customization

You can choose which product-level events you want to subscribe to. Available categories:

  • Automation

  • CRM

  • Developer APIs

  • Campaigns


3. Basic Authentication πŸ”’

For security, your endpoint must have Basic Authentication enabled. If your endpoint is public, you can input any placeholder values for authentication.

  1. Input Credentials in Our System

    • Provide the <encoded_credentials> in the authentication input field during webhook setup in our system.


Getting Started

Steps to Set Up Event Forwarding

  1. Navigate to the Developer Tools Page

    • Go to your system settings and select Event Forwarding.

  2. Subscribe to Events

    • Select the events and products you want to subscribe to (Sent, Delivered, Read, Failed, etc.).

  3. Provide Endpoint Details

    • Enter your endpoint URL and the encoded authentication credentials.

  4. Test the Setup

    • Use the Test Event option to ensure your endpoint receives events correctly.

  5. Save and Activate

    • Once tested, save your configuration to activate the event forwarding feature.


Event Structure

Each event forwarded to your endpoint follows a standard structure:

jsonCopy code{ "event": "event_type", "timestamp": "event_timestamp", "data": { "message_id": "unique_message_id", "status": "event_status", "details": { // Additional event-specific details } } }

Sample Event

For detailed examples and field definitions, refer to the Webhook Documentation.


FAQs

1) What happens if the event forwarding fails?

If we encounter delivery failures to your endpoint, retries will be attempted based on our retry policy.

2) Can I update my subscriptions later?

Yes, you can modify your subscriptions from the Event Forwarding Settings page.

3) Do I need Basic Authentication if my endpoint is public?

Yes, but you can provide any placeholder values for the username and password.


For further assistance or to raise feature requests related to Webhook Integration, please contact [email protected].

Did this answer your question?