Skip to main content
All CollectionsGeneral
Set up Webhooks
Set up Webhooks

In this guide, you'll learn how to create and manage your webhooks to integrate Voicenotes with your own applications or services.

Updated over 2 weeks ago

Webhooks allow you to receive real-time notifications about specific events in your Voicenotes account. This guide will walk you through setting up and managing webhooks to integrate Voicenotes with your own applications or services.

In this guide, you’ll learn how to:

  1. Access the Webhooks Integration in Voicenotes

  2. Create a new Webhook

  3. Manage your Webhook (enable/disable, delete your webhook, and the available events)

We are also including a sample Webhook payload for your reference.

1. Accessing the Webhooks Integration

  1. Log in to your Voicenotes account.

  2. Click on your profile icon in the top-right corner.

  3. Navigate to "Integrations" in the sidebar.

  4. Click on "Webhooks" to access the webhook management page.

2. Creating a Webhook

Follow these steps to create a new webhook:

1. Navigate to Webhooks

From the Webhooks page, you will see a list of your existing webhooks (if any).

2. Add Your Webhook URL

  1. Click on the "Add Webhook" button.

  2. In the "Webhook URL" field, enter the URL where you want to receive POST requests.

    • Note: Ensure that your URL is accessible and can accept POST requests from Voicenotes.

3. Select Events

Choose the events that will trigger the webhook:

  • Creating Notes: Triggers when a new note is created.

  • Updating Notes: Triggers when an existing note is updated.

  • Deleting Notes: Triggers when a note is deleted.

    • Tip: You can select one or multiple events based on your integration needs.

4. Create the Webhook

  1. Review your settings.

  2. Click on the "Create" button to finalize the webhook setup.

    • You will be redirected back to the Webhooks list, where your new webhook will appear.

3. Managing Your Webhooks

Enabling or Disabling a Webhook

  • In the Webhooks list, you'll see a toggle switch next to each webhook.

    • To Disable: Toggle the switch off. The webhook will no longer send notifications.

    • To Enable: Toggle the switch on. The webhook will resume sending notifications.

    • Note: Disabling a webhook does not delete it; you can re-enable it at any time.

Deleting a Webhook

  1. In the Webhooks list, locate the webhook you want to delete.

  2. Click on the three dots menu (⋮) next to the webhook.

  3. Select "Delete" from the dropdown options.

    • Warning: Deleting a webhook is irreversible. You will need to create a new webhook if you want to restore it.

Available Events

  • Creating Notes: Triggered when a new note is added to your Voicenotes account.

  • Updating Notes: Triggered when an existing note is modified.

  • Deleting Notes: Triggered when a note is removed from your account.

Each event will send a payload to your specified webhook URL containing relevant data about the note and the event type.

Sample Webhook Payload

Here's a sample Webhook Payload for your reference: 

{ 
   "data": { 
     "id": "SAMPLE_ID", 
     "title": "Sample Title", 
     "transcript": "Sample Transcript" 
    }, 
    "event": "recording.created", 
    "timestamp": "2024-11-04T06:04:00+00:00" 
}

Need More Help?

If you have any questions or encounter any issues, please reach out to us at [email protected]

Did this answer your question?