Back to Help

api

Webhooks

Receive async render updates and validate incoming events.

Audience: developer

Webhook Endpoints

  • POST /v1/webhooks
  • GET /v1/webhooks
  • GET /v1/webhooks/:id
  • DELETE /v1/webhooks/:id
  • POST /v1/webhooks/:id/test

Supported events:

  • render.completed
  • render.failed
  • render.progress

Create Webhook

curl -s https://api.slidevids.com/v1/webhooks \
  -X POST \
  -H "x-api-key: $SLIDEVIDS_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "url": "https://example.com/hooks/slidevids",
    "events": ["render.completed", "render.failed"]
  }'

Creation returns a signing_secret once. Store it securely.

Signature Headers

SlideVids webhook requests include:

  • x-slidevids-signature
  • x-slidevids-event
  • x-slidevids-event-id

Test Delivery

curl -s https://api.slidevids.com/v1/webhooks/wh_xxx/test \
  -X POST \
  -H "x-api-key: $SLIDEVIDS_API_KEY" \
  -H "content-type: application/json" \
  -d '{"event":"render.completed"}'

Related: /help/api/errors-and-rate-limits