Webhook Notifications

Receive status change notifications for processing tasks. Authentication is done through the Authorization header, same as other APIs.

Configure the webhook URL in the admin dashboard we provided.

Endpoint

Request Body

type RequestBody = {
  // Notification for successful processing
  eventType: 'TRANSCRIBE_DONE' | 'ARTICLE_DONE',
  uuid: string,
} | {
  // Notification for processing errors
  eventType: 'TRANSCRIBE_ERROR' | 'ARTICLE_ERROR',
  uuid: string,
  errorCode: string,
}

Response

The response body is not important, only the HTTP status code matters. If the response status is not 2xx, up to 3 retry attempts will be made.