Create Webhook

🔔 Add a Webhook

Create a new webhook to receive notifications when transcriptions are complete.

Endpoint

POST https://api.tor.app/developer/integrations/webhooks

POST Body Parameters

• url (string, required): The web address where notifications are sent.
• export_format (string, optional): Choose the transcript format: Txt, Json, or Csv. Default: Txt.
• include_timestamps (boolean, optional): Set to true to add timestamps. Default: false.
• include_speaker_names (boolean, optional): Set to true to include speaker names. Default: false.
• merge_same_speaker_segments (boolean, optional): Set to true to combine parts by the same speaker. Default: false.
• is_single_paragraph (boolean, optional): Set to true for one big paragraph. Default: false.
• paragraph_size (integer, optional): Lines per paragraph (if not single paragraph). Suggested: 1, 2, 4, or 8. Default: 1.
• folder_id (string, optional): Send notifications only for transcriptions in this folder. Default: none.

Responses

{
    "message": "Webhook registered.",
    "webhookType": "wh 2025-05-02 12:34:56"
}
        

"Invalid or missing webhook URL."
        

"Webhook already exists."
        

"Failed to register webhook."
        

Notes

• Save the webhookType to manage the webhook later.
• Notifications sent to the url include details like file ID and name.