Skip to content

Send a test message

Posts a `webhook.test` message synchronously and returns the attempt.

POST
/v1/webhook-endpoints/{endpointId}/test

Posts a webhook.test message synchronously and returns the attempt.

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: webhooks:write

Path Parameters

endpointId*string

An opaque we_ id.

Match^we_[0-9A-Za-z]{16,64}$

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Idempotency-Key?string

1–255 characters of [A-Za-z0-9._:-] (a UUID v4 is recommended); never PHI. Stored 24 hours per app.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/webhook-endpoints/we_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e/test" \  -H "Content-Type: application/json" \  -d '{}'
{  "attemptCount": -9007199254740991,  "attempts": [    {      "durationMs": -9007199254740991,      "errorCode": "string",      "n": -9007199254740991,      "responseHeaders": [        {          "name": "string",          "value": "string"        }      ],      "responseSnippet": "string",      "responseStatus": -9007199254740991,      "signatureVersions": [        -9007199254740991      ],      "startedAt": "2026-09-14T15:00:11.402Z"    }  ],  "createdAt": "2026-09-14T15:00:11.402Z",  "endpointId": "we_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "eventExpiresAt": "2026-09-14T15:00:11.402Z",  "eventType": "string",  "id": "dlv_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",  "lastAttemptAt": "2026-09-14T15:00:11.402Z",  "lastErrorCode": "string",  "lastResponseStatus": -9007199254740991,  "messageId": "string",  "nextAttemptAt": "2026-09-14T15:00:11.402Z",  "object": "webhook_delivery",  "payload": {    "property1": null,    "property2": null  },  "status": "pending",  "succeededAt": "2026-09-14T15:00:11.402Z",  "trigger": "event"}

Was this page helpful?