Webhook Notifications

Receive status change notifications for processing tasks. Each request includes Authorization: Bearer <token>, using the active API access token selected in the Enterprise Console webhook configuration.

Configure the webhook URL in the Enterprise Console.

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,
} | {
  // Notification for successful translation
  eventType: 'TRANSLATE_DONE',
  language: string,
  uuid: string,
} | {
  // Notification for translation errors
  eventType: 'TRANSLATE_ERROR',
  language: string,
  uuid: string,
  errorCode: string,
} | {
  // Podwise Open API episode processing completed successfully
  eventType: 'OPEN_API_TRANSCRIBE_DONE',
  episodeSeq: number,
} | {
  // Podwise Open API episode processing failed
  eventType: 'OPEN_API_TRANSCRIBE_ERROR',
  episodeSeq: number,
  errorCode: string,
}

The OPEN_API_TRANSCRIBE_* events are sent when an Enterprise user starts processing through the Podwise Open API. They use the Podwise episode sequence number instead of the customer-provided uuid used by the Enterprise Processing API. Open API and Enterprise Processing API webhook events use the same configured URL and selected access token.

If the episode was already processed and the Open API request immediately returns done, no webhook is sent. Creating a new task, restarting a failed task, or joining an existing task registers one webhook for that processing cycle.

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. Webhook delivery is best effort and does not change the episode processing result.