Update a webhook

PUT/webhooks/{webhookID}

Updates a webhook subscription's target URL or subscribed event types and returns the updated resource.

Auth:Bearer

Path parameters

webhookID

uuidrequired

Request body

url

string

events

string[]

active

boolean

Response

id

Unique identifier for this resource.

uuid

family_id

Identifier of the family this resource belongs to.

uuid

url

HTTPS endpoint that receives POSTed webhook events.

string

events

List of event types this webhook subscribes to.

string[]

active

Whether the webhook is currently active and receiving deliveries.

boolean

created_at

RFC 3339 timestamp of when the resource was created.

datetime

updated_at

RFC 3339 timestamp of the resource's most recent update.

datetime

Request

bash

curl -sS -X PUT "https://phosra-api-sandbox-production.up.railway.app/api/v1/webhooks/8a1b2c3d-4e5f-4a6b-9c8d-1e2f3a4b5c6d" \
  -H "Authorization: Bearer $PHOSRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://yourapp.com/webhooks/phosra",
  "events": [
    "enforcement.completed"
  ],
  "active": true
}'

Response

json

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "family_id": "550e8400-e29b-41d4-a716-446655440000",
  "url": "string",
  "events": [
    "string"
  ],
  "active": true,
  "created_at": "2025-01-15T09:30:00Z",
  "updated_at": "2025-01-15T09:30:00Z"
}