Change Status

Enables or disables a registered webhook for a specific event type.

Overview

The PATCH /webhook/status endpoint allows you to activate or deactivate a registered webhook for a specific event type.

Key Steps:

1. Send a PATCH request to /webhook/status with the event_type, is_active status, and organization_public_id.
2. If successful, the webhook will be updated, and notifications will either be enabled or disabled accordingly.

---

Example Request

To disable a webhook for the "scribe" event type, send the following request:

{
  "event_type": "scribe",
  "is_active": false,
  "organization_public_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

X-API-Version

string

required

API versioning is required. Include the header X-API-Version with current version value in all requests.

Example:

"v1"

Body

application/json

Payload to update the webhook status.

event_type

string

required

The type of event associated with the webhook.

Example:

"scribe"

is_active

boolean

required

Determines whether the webhook is active (true) or inactive (false).

Example:

false

organization_public_id

string

required

The unique identifier for the organization that owns the webhook.

Example:

"<string>"

Response

200 - application/json

Webhook's is_active status updated successfully.

message

string

Example:

"Webhook's is_active status updated successfully"

data

object

Show child attributes

data.public_id

string

Example:

"<string>"

data.event_type

string

Example:

"scribe"

data.is_active

boolean

Example:

false

data.organization_public_id

string

Example:

"<string>"