AudioPen

Webhook Documentation

This document provides detailed instructions on how to set up and use the webhooks functionality in AudioPen to push your notes to other applications in real-time.

1. What is a Webhook?

A webhook allows AudioPen to send your note data to a specified URL in real-time. This can be useful if you want to integrate AudioPen with other apps or services.

2. Data Sent by AudioPen

When you save a note, AudioPen sends the following data in JSON format:

Field	Type	Description
`id`	String	A unique identifier for your note.
`title`	String	The title you've given to your note.
`body`	String	The main content of your note.
`orig_transcript`	String	The original transcript if the note was created from a voice note.
`folder`	String	The name of the folder that the note is in.
`tags`	Comma-separated list	Any tags you've associated with your note, separated by commas.
`date_created`	ISO Date-Time Format	The date and time when the note was created, in simplified extended ISO format (e.g., "2023-10-01T12:34:56Z").

The data is sent after a 4 minute delay, so you have some time to make edits to your note, or add tags, before the data is sent to the webhook.

3. Setting Up Your Webhook

1. Activate the Webhook section
Go to your AudioPen settings. Then go into the Integration section and toggle on the Automatic Webhook feature. If you want to create manually triggered webhooks, toggle them on as well.
2. Enter Your Webhook URL
In the provided field, enter the URL where you want AudioPen to send the note data. Ensure that the URL starts with "https://".
3. Receiving Data in Your App
Your application or service will need to listen for incoming HTTP POST requests from AudioPen. The body of this request will contain the note data in JSON format, as described in section 2.

For example, the incoming data might look like this:

{
    "id": "abc12345",
    "title": "Meeting Notes",
    "body": "Discussed project X and Y.",
    "orig_transcript": "Discussed project X and then project Y.",
    "tags": "meeting, projectX, projectY",
    "date_created": "2023-10-01T12:34:56Z"
}

Do what you wish to do with your data: Once you’ve captured the data, send it wherever, or process it however you like.

1. What is a Webhook?

2. Data Sent by AudioPen

3. Setting Up Your Webhook

1. Activate the Webhook section

2. Enter Your Webhook URL

3. Receiving Data in Your App