Set up webhooks for developers

Steps

1. Step 1 of 9

   Open Developers › Webhooks

   Webhooks are set up in the Developers section.

   Webhooks extend the integration with custom automations and are meant for developers and technical administrators. In the Bridge admin console, open Developers › Webhooks in the sidebar.

   • Developers › Webhooks
   • For developers and technical administrators

   Watch step 1 on the screen

2. Step 2 of 9

   Enter the Callback URL

   Bridge sends the events to your endpoint.

   In Callback URL, enter the endpoint that will receive the webhook events, for example https://your-service.example.com/webhook. It is a required field.

   • The endpoint that receives the events
   • Required field

   Watch step 2 on the screen

3. Step 3 of 9

   Enter the Bridge-API-Key

   The API key authenticates the subscription.

   In Bridge-API-Key, enter the API key. It is the authentication header used to authenticate webhook subscription requests. It is a required field.

   • Authentication header
   • Authenticates subscription requests
   • Required field

   Watch step 3 on the screen

4. Step 4 of 9

   Enter the Client Secret

   The secret protects every delivery.

   In Client Secret, enter the secret used to create an HMAC signature (hash-based message authentication code). The signature verifies the integrity of each webhook payload and prevents spoofing. It is a required field.

   • Creates the HMAC signature
   • Verifies integrity and prevents spoofing
   • Required field

   Watch step 4 on the screen

5. Step 5 of 9

   Verify the signature at your endpoint

   Your service checks that the event comes from Bridge.

   Every webhook payload is signed with HMAC using the Client Secret. Your endpoint should verify the signature before processing the payload, to make sure it came from Bridge.

   • Every payload is signed with HMAC
   • Verify the signature before processing

   Watch step 5 on the screen

6. Step 6 of 9

   Verify and save

   Save the webhook settings.

   With the three fields filled in, click Verify and save.

   • Fill in the three fields
   • Click Verify and save

   Watch step 6 on the screen

7. Step 7 of 9

   Review CRM Connected Features

   Some features are already reported with the CRM connected.

   CRM Connected Features lists the features that are reported automatically when a CRM is connected, such as Contact Updates. You can also configure them for a custom webhook if you need to route them elsewhere.

   • Reported with the CRM connected
   • Contact Updates
   • Configurable for a custom webhook

   Watch step 7 on the screen

8. Step 8 of 9

   Choose Custom Integration Features

   Other features are turned on as you need them.

   Custom Integration Features are opt-in webhooks for building automations on specific event types, all in version V1. Task Notifications fires when a task is created, updated or completed; Call Notifications, when a call is logged in Bridge; Meeting Notifications, when a meeting is created or updated; Email Notifications, when an email activity is tracked; and Conversation Summary Notifications, when a daily AI-generated conversation summary is created.

   • Opt-in webhooks, version V1
   • Tasks, calls, meetings, emails and summaries

   Watch step 8 on the screen

9. Step 9 of 9

   Test each feature with Test

   Check the integration before you rely on it.

   Each configured feature has a Test button in the Webhooks screen. Use it to send a sample payload to your endpoint and check that your integration works correctly. If you need help, contact support at support@sainapsis.com.

   • Click Test
   • Your endpoint gets a sample payload
   • Check that the integration works

   Watch step 9 on the screen