Skip to content

Endpoints

MethodPathPurpose
POST/webhooksCreate
GET/webhooksList
GET/webhooks/:idGet one
PATCH/webhooks/:idUpdate
DELETE/webhooks/:idRemove
GET/webhooks/:id/deliveriesInspect recent deliveries

POST /webhooks

bash
curl -X POST https://api.socifyr.com/api/webhooks \
  -H "Authorization: Bearer sk_..." \
  -H "X-Workspace-Id: <workspaceId>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://myapp.com/webhooks/socifyr",
    "events": ["upload.completed", "upload.failed", "upload.partial_failure"],
    "secret": "whsec_..."
  }'
FieldDescription
urlHTTPS endpoint that receives events
eventsArray of event names
secretUsed to sign deliveries — Socifyr generates one if omitted

See Webhook events for the full event list.

GET /webhooks/:id/deliveries

json
{
  "success": true,
  "data": [
    {
      "id": "...",
      "event": "upload.completed",
      "url": "https://myapp.com/webhooks/socifyr",
      "statusCode": 200,
      "deliveredAt": "...",
      "attempts": 1,
      "responseBody": "{ \"ok\": true }"
    }
  ]
}

The 100 most-recent deliveries are kept.