List Webhook Endpoints — GET /webhooks

The List Webhook Endpoints endpoint returns every webhook you have registered for your clinic, along with the event types each endpoint subscribes to and its current active state. Use this endpoint to audit your integrations, verify subscriptions, or build a management UI over your webhook configuration.

Endpoint

GET https://api.bydoctor.com.br/v1/webhooks

Authentication

Include your API key as a Bearer token in the Authorization header of every request.

Authorization: Bearer YOUR_API_KEY

Query Parameters

integer

default:"20"

Number of webhook records to return per page. Maximum value is 100.

string

Pagination cursor returned in the previous response’s meta.next_cursor. Omit this parameter to start from the first page.

Response Fields

array

Array of webhook endpoint objects registered to your clinic.

Show Webhook object fields

string

Unique identifier for the webhook endpoint (UUID).

string

Identifier of the clinic that owns this webhook.

string

The HTTPS URL where ByDoctor delivers event payloads.

array

List of event names this endpoint is subscribed to (e.g. ["appointment.created", "payment.paid"]).

boolean

true if the endpoint is active and will receive event deliveries. false if the endpoint has been paused.

string

ISO 8601 UTC timestamp of when this webhook was registered.

object

Pagination metadata for the current result set.

Show Meta fields

integer

Total number of webhook endpoints registered for your clinic.

boolean

true if there are additional pages beyond the current one.

string

Cursor to pass as the cursor query parameter to fetch the next page. null when has_more is false.

The secret field is never returned when listing webhooks. It is only included in the response when you first create the endpoint via POST /webhooks. If you lose your secret, you will need to delete the existing webhook and create a new one to receive a fresh signing secret.

Error Responses

Status	Code	Description
`401 Unauthorized`	`unauthorized`	Your API key is missing or invalid.

Example Request

curl --request GET \
  --url "https://api.bydoctor.com.br/v1/webhooks" \
  --header "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "data": [
    {
      "id": "wh_c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "clinic_id": "clinic_01HXYZ",
      "url": "https://app.example.com/webhooks/bydoctor",
      "events": [
        "appointment.created",
        "appointment.confirmed",
        "appointment.cancelled",
        "payment.paid"
      ],
      "active": true,
      "created_at": "2024-05-10T08:30:00Z"
    },
    {
      "id": "wh_d2e3f4a5-b6c7-8901-defa-23456789abcd",
      "clinic_id": "clinic_01HXYZ",
      "url": "https://reporting.example.com/hooks/payments",
      "events": [
        "payment.created",
        "payment.paid",
        "payment.cancelled"
      ],
      "active": false,
      "created_at": "2024-03-22T11:15:44Z"
    }
  ],
  "meta": {
    "total": 2,
    "has_more": false,
    "next_cursor": null
  }
}

Appointments

Patients

Schedules & Availability

Payments

Webhooks

List Webhook Endpoints — GET /webhooks | ByDoctor API

Endpoint

Authentication

Query Parameters

Response Fields

Error Responses

Example Request

Example Response

​Endpoint

​Authentication

​Query Parameters

​Response Fields

​Error Responses

​Example Request

​Example Response

Endpoint

Authentication

Query Parameters

Response Fields

Error Responses

Example Request

Example Response