Search
⌃K
Links

Webhooks

Listen for events on your BeyondWords account so your integration can automatically trigger reactions.
We've launched a new API in beta! Contact us at [email protected] to get early access
You can use our webhooks to recieve notifications when an event takes place. You can enter your webhook endpoint in the 'Settings (Webhooks)' section of your project dashboard. Please make sure the toggle in the top-right is switched to 'Webhooks enabled'.
BeyondWords webhooks are POST requests with JSON data. Event types are in the action_type field and include audio.created, audio.updated, and audio.deleted.
🔒 This feature is available on Enterprise plans only.

Audio created or updated

{
"id":284568,
"external_id":"629bb065-9699-4d85-b069-890884b6685c",
"state":"processed",
"metadata":{
​
},
"media":[
{
"id":2236642,
"content_type":"m3u8",
"url":"https://speechkit-staging.s3.amazonaws.com/audio/projects/3438/podcasts/284568/media/2ffc1bff61a0779e5d07b78f32db4c9e.m3u8",
"duration":2.564622
},
{
"id":2236641,
"content_type":"mp3",
"url":"https://speechkit-staging.s3.amazonaws.com/audio/projects/3438/podcasts/284568/media/2d6e5234b1f940c0f164066f1d6fa166_compiled.mp3",
"duration":2.592
}
],
"image_url":null,
"deleted":false,
"action_type":"audio.updated",
"project_id":"3438"
}

Audio deleted

{
"id":284568,
"external_id":"629bb065-9699-4d85-b069-890884b6685c",
"state":"processed",
"metadata":{
​
},
"media":[
​
],
"image_url":null,
"deleted":true,
"action_type":"audio.deleted",
"project_id":"3438"
}
​