List webhook endpoints
Oldest first. Signing secrets are never shown again after they are made.
GET
/v1/webhooksRequest
| Method and path | GET/v1/webhooks |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
Query parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
after | string | – | – | The next value of the previous page (same filters and sort). Opaque; do not build it yourself. |
limit | integer | 100 | – | From 1 to 200. |
curl "https://api.boxline.dev/v1/webhooks" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLfor await (const w of bx.webhooks.list()) console.log(w.id, w.url, w.enabled, w.events);from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLfor w in bx.webhooks.list(): print(w["id"], w["url"], w["enabled"], w["events"])Responses
200 OK
A page of endpoints.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
data | object[] | – | – | |
data[].id | string | – | – | |
data[].url | string | – | – | Format: uri. |
data[].events | string[] | – | – | The types it gets, or ["*"] for all of them. |
data[].description | string | null | – | – | |
data[].enabled | boolean | – | – | |
data[].disabledReason | string | null | – | user, gone, failing, account_recovered, null | user: switched off with PATCH; gone: it answered 410; failing: 3 days of failed deliveries; account_recovered: a password reset recovered an account whose email was not confirmed. null while enabled. |
data[].disabledAt | string | null | – | – | Format: date-time. |
data[].failingSince | string | null | – | – | The first failed delivery since the last success. Format: date-time. |
data[].lastSuccessAt | string | null | – | – | Format: date-time. |
data[].lastFailureAt | string | null | – | – | Format: date-time. |
data[].secretRotatedAt | string | null | – | – | Format: date-time. |
data[].previousSecretExpiresAt | string | null | – | – | Until then deliveries are signed with the secret before the last rotation too. Format: date-time. |
data[].pausedUntil | string | null | – | – | Deliveries wait until then because the endpoint timed out 3 times in a row (test events still go). Format: date-time. |
data[].createdAt | string | – | – | Format: date-time. |
data[].updatedAt | string | – | – | Format: date-time. |
next | string | null | – | – | Pass it back as after for the next page; null on the last page. |
{ "data": [ { "id": "wh_Hk2Lq8Zx0Vb5Nm1C", "url": "https://example.com/", "events": [ "session.started" ], "description": "…", "enabled": false, "disabledReason": "user", "disabledAt": "2026-09-29T10:00:00.000Z", "failingSince": "2026-09-29T10:00:00.000Z", "lastSuccessAt": "2026-09-29T10:00:00.000Z", "lastFailureAt": "2026-09-29T10:00:00.000Z", "secretRotatedAt": "2026-09-29T10:00:00.000Z", "previousSecretExpiresAt": "2026-09-29T10:00:00.000Z", "pausedUntil": "2026-09-29T10:00:00.000Z", "createdAt": "2026-09-29T10:00:00.000Z", "updatedAt": "2026-09-29T10:00:00.000Z" } ], "next": "eyJvIjoiY3JlYXRlZF9kZXNjIiwidCI6IjIwMjYtMDktMjlUMTA6MDA6MDAuMTIzNDU2WiIsImkiOiI2YzFmIn0"}Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 400 Bad Request | invalid_request, invalid_json, invalid_cursor, invalid_idempotency_key, invalid_extension, variables_with_extensions, terms_not_accepted, invalid_reset_token, invalid_confirmation_code, wrong_password, no_password, invalid_next, invalid_oauth_token | The request is not valid. |
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.