JOjoinsophic
webhooks

Update a webhook

Changed on

Update an existing webhook.

put/webhooks/{webhook_id}

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

webhook_idstring required

The ID of the webhook to update.

Request body

descriptionstring

Human-readable purpose of the webhook.

is_activeboolean

Whether the webhook is active.

urlstring

HTTPS URL that receives webhook deliveries; IP addresses are rejected.

Example request

{
  "url": "https://example.com/webhook"
}

Response

OK

created_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was created.

descriptionstring nullable required

Webhook purpose.

idstring required

Unique resource identifier.

is_activeboolean required

Whether the webhook is active.

modified_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was last modified.

urlstring required

Webhook destination URL.

Changes