Request

Method and path	GET`/v1/webhooks/{id}`
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`.

Path parameters

Name	Type	Default	Allowed values	Description
`id`required	`string`	–	–

curl "https://api.boxline.dev/v1/webhooks/$WEBHOOK_ID" \  -H "x-api-key: $BOXLINE_API_KEY"

import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst w = await bx.webhooks.get("WEBHOOK_ID");console.log(w.enabled, w.disabledReason, w.lastSuccessAt, w.pausedUntil);

from boxline import Boxlinebx = Boxline()  # reads BOXLINE_API_KEY and BOXLINE_API_URLw = bx.webhooks.get("WEBHOOK_ID")print(w["enabled"], w["disabledReason"], w["lastSuccessAt"], w["pausedUntil"])

Responses

200 OK

The endpoint.

Fields

Name	Type	Default	Allowed values	Description
`id`	`string`	–	–
`url`	`string`	–	–	Format: uri.
`events`	`string[]`	–	–	The types it gets, or ["*"] for all of them.
`description`	`string \| null`	–	–
`enabled`	`boolean`	–	–
`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.
`disabledAt`	`string \| null`	–	–	Format: date-time.
`failingSince`	`string \| null`	–	–	The first failed delivery since the last success. Format: date-time.
`lastSuccessAt`	`string \| null`	–	–	Format: date-time.
`lastFailureAt`	`string \| null`	–	–	Format: date-time.
`secretRotatedAt`	`string \| null`	–	–	Format: date-time.
`previousSecretExpiresAt`	`string \| null`	–	–	Until then deliveries are signed with the secret before the last rotation too. Format: date-time.
`pausedUntil`	`string \| null`	–	–	Deliveries wait until then because the endpoint timed out 3 times in a row (test events still go). Format: date-time.
`createdAt`	`string`	–	–	Format: date-time.
`updatedAt`	`string`	–	–	Format: date-time.

Response 200

{  "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"}

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
401 Unauthorized	`unauthorized`	Missing or invalid API key.
404 Not Found	`not_found`, `invite_not_found`, `provider_unavailable`	No such thing in this project (or organization), or no such route.

Error body

{  "error": {    "code": "not_found",    "message": "session not found",    "requestId": "req_4fJx0aQm2Lk9Pz7N"  }}

Learn more

WebhooksThe guide to this part of the API, with more examples.

These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.