ProfileClaw

API guide

Webhooks

Webhooks covers subscription creation, signature verification, and event-driven sync patterns.

Path: /api/v1/webhooks
Format: AI-first docs
Info

Contract-backed page

This page is generated from the current OpenAPI contract summary so docs stay aligned with the formal API surface.

GET /api/v1/webhooks

List webhook subscriptions

Required scopes

  • read:webhooks

Request

  • no extra request parameters

Responses

  • 200: OK
  • 401:
  • 403:
  • 429:
  • 500:

Errors

  • none documented

Examples

Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/webhooks" -H "Authorization: Bearer $PROFILECLAW_API_KEY"

POST /api/v1/webhooks

Create a webhook subscription

Webhook deliveries include headers X-Webhook-Event, X-Webhook-Delivery, and X-Webhook-Signature (HMAC-SHA256 hex of the raw JSON body using your subscription secret).

Required scopes

  • write:webhooks

Request

  • request body available

Responses

  • 201: Created
  • 400: Bad request
  • 401:
  • 403:
  • 429:
  • 500:

Errors

  • webhooks.missing_required_fields
  • webhooks.invalid_url
  • webhooks.invalid_events

Examples

Code sample (curl)
1curl "https://api.profileclaw.com/api/v1/webhooks" -H "Authorization: Bearer $PROFILECLAW_API_KEY" -H "Content-Type: application/json" -d '{"url":"https://example.com/profileclaw/webhook","events":["assessment.completed","profile.updated"]}'

DELETE /api/v1/webhooks

Delete a webhook subscription

Required scopes

  • write:webhooks

Request

  • id (query): Subscription ID

Responses

  • 200: OK
  • 400: Bad request
  • 401:
  • 403:
  • 404:
  • 429:
  • 500:

Errors

  • webhooks.missing_subscription_id

Examples

Code sample (curl)
1curl -X DELETE "https://api.profileclaw.com/api/v1/webhooks?id=sub_123" -H "Authorization: Bearer $PROFILECLAW_API_KEY"

Related surfaces

Use these surfaces when you need deeper inspection or automation.

Open Reference
Open OpenAPI