PUT
/
webhook
/
update
curl --request PUT \
  --url https://scribe-api.puppilot.co/webhook/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event_type": "scribe",
  "webhook_url": "https://your-webhook-url.com/webhook-handler",
  "auth_token": "your-secret-token"
}'
{
  "message": "Webhook updated successfully",
  "data": {
    "public_id": "5e11d9c6-b7e5-4717-9688-ad727f51677f",
    "event_type": "scribe",
    "is_active": true,
    "organization_public_id": "6691d22b-fee0-411c-8df1-ef12769747cb"
  }
}

​
Overview

To receive webhook events from our system, you must first register your webhook URL. This ensures that our platform knows where to send event notifications for the specified event type.

​
Example Request

{
  "event_type": "scribe",
  "webhook_url": "https://your-webhook-url.com/webhook-handler",
  "auth_token": "your-secret-token"
}

The scribe event type triggers a notification to your webhook at different stages of the scribing process, allowing your system to track progress and take action accordingly.

​
Webhook Triggers

The scribe webhook fires at the following stages:

  • When a scribe request is created
  • When the scribe process starts
  • When the scribe process completes

Each webhook event contains relevant information, including the recording session public ID. The status field indicates the current stage of the process. The final webhook also includes the output JSON and HTML.

All webhook events have event_type: scribe, ensuring clarity that they are related to the scribing process.

​
Example Webhook Payloads

  1. When a scribe request is created
{
  "public_id": "72e123a0-95f8-4c10-af00-7382b3719dk",
  "recording_session_public_id": "d7db54cb-a097-40e7-a31f-4c3395510e70",
  "status": "requested",
  "event_type": "scribe"
}
  1. When the scribe process starts
{
  "public_id": "72e123a0-95f8-4c10-af00-7382b3719dk",
  "recording_session_public_id": "d7db54cb-a097-40e7-a31f-4c3395510e70",
  "status": "scribing",
  "event_type": "scribe"
}
  1. When the scribe process completes
{
  "public_id": "72e123a0-95f8-4c10-af00-7382b3719dk",
  "recording_session_public_id": "d7db54cb-a097-40e7-a31f-4c3395510e70",
  "status": "scribed",
  "event_type": "scribe",
  "categories_output": [], 
  "html_output": "" 
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Webhook details that need to be registered.

The body is of type object.

Response

200
application/json

Webhook received and validated successfully.

The response is of type object.