Scraper apiV1Webhooks

List Webhooks

Coming soon

This endpoint is documented but not yet available in production. The contract below reflects the planned behavior. Reach out via support for early access or launch notification.

List webhooks registered for the current user with pagination

GET
/v1/webhooks

Authorization

APIKeyHeader
X-Api-Key<token>

In: header

Query Parameters

page?Page

Page number (must be greater than 0)

page_size?Page Size

Number of results per page (max 100)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/webhooks"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "url": "string",
      "description": "string",
      "is_active": true,
      "event_type": "extract_completed",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "page_count": 0
}
{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "correlation_id": "string",
  "retryable": true
}