> ## Documentation Index > Fetch the complete documentation index at: https://docs.endstate.io/llms.txt > Use this file to discover all available pages before exploring further. # Send a test event to a webhook endpoint > Delivers the catalog's example payload for the given event type to this endpoint only, signed and retried like any delivery. The event has audience `test`. A failed test delivery counts toward endpoint health like a real one, and a successful one clears the failure run. Returns the event and its first attempt; follow progress through the event's attempts. ## OpenAPI ````yaml /openapi.json post /v1/webhooks/endpoints/{endpoint_id}/test openapi: 3.1.0 info: title: Endstate API version: 0.1.0 description: Endstate developer API for chip verification and ownership workflows. servers: - url: https://api2.endstate.io description: Production - url: https://api-staging.endstate.io description: Staging security: [] paths: /v1/webhooks/endpoints/{endpoint_id}/test: post: tags: - Webhooks summary: Send a test event to a webhook endpoint description: >- Delivers the catalog's example payload for the given event type to this endpoint only, signed and retried like any delivery. The event has audience `test`. A failed test delivery counts toward endpoint health like a real one, and a successful one clears the failure run. Returns the event and its first attempt; follow progress through the event's attempts. operationId: testWebhookEndpoint parameters: - schema: type: string format: uuid example: 8e1a7f50-90ab-4cde-8012-3456789abcde required: true name: endpoint_id in: path - schema: type: string minLength: 1 maxLength: 255 description: >- Unique key that makes this request safe to retry. Replaying the key with the same body returns the original response with `Idempotent-Replayed: true`; replaying it with a different body returns 409 `idempotency.key_conflict`. example: a1b2c3d4-0000-4000-8000-000000000000 required: false name: Idempotency-Key in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TestWebhookEndpointRequest' example: event_type: example.updated responses: '202': description: The test event and its first delivery attempt. content: application/json: schema: $ref: '#/components/schemas/WebhookTestDelivery' example: event: id: 3f1c9a2b-7d4e-4f10-9a8b-2c6d5e4f3a21 type: example.updated audience: test api_version: '2026-09-01' resource: type: webhook_endpoint id: 8e1a7f50-90ab-4cde-8012-3456789abcde revision: 1 created_at: '2026-09-22T12:00:00.000Z' attempt: attempt: 1 status: pending response_status_code: null duration_ms: null error: null next_attempt_at: '2026-09-22T12:00:00.000Z' created_at: '2026-09-22T12:00:00.000Z' endpoint: id: 8e1a7f50-90ab-4cde-8012-3456789abcde url: https://hooks.example.com/endstate deleted: false '400': description: >- The request was malformed or failed validation. | Error code | When | | --- | --- | | `validation.failed` | The request failed schema validation. See `error.details` for per-field issues. | | `webhook_event_type.unknown` | One of the event types is not a supported webhook event. | x-error-codes: - validation.failed - webhook_event_type.unknown content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validation.failed: summary: >- The request failed schema validation. See `error.details` for per-field issues. value: error: code: validation.failed message: >- The request failed schema validation. See `error.details` for per-field issues. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/validation-failed webhook_event_type.unknown: summary: One of the event types is not a supported webhook event. value: error: code: webhook_event_type.unknown message: One of the event types is not a supported webhook event. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: >- https://docs.endstate.io/errors/webhook-event-type-unknown '401': description: |- Authentication failed. | Error code | When | | --- | --- | | `auth.unauthorized` | Credential is missing or malformed. | x-error-codes: - auth.unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: auth.unauthorized: summary: Credential is missing or malformed. value: error: code: auth.unauthorized message: Credential is missing or malformed. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/auth-unauthorized '403': description: >- Authenticated, but not permitted. | Error code | When | | --- | --- | | `auth.forbidden` | Credential is valid but does not have access to the requested resource or action. | x-error-codes: - auth.forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: auth.forbidden: summary: >- Credential is valid but does not have access to the requested resource or action. value: error: code: auth.forbidden message: >- Credential is valid but does not have access to the requested resource or action. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/auth-forbidden '404': description: >- The resource does not exist within your organization. | Error code | When | | --- | --- | | `webhook_endpoint.not_found` | The webhook endpoint does not exist in your organization. | x-error-codes: - webhook_endpoint.not_found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: webhook_endpoint.not_found: summary: The webhook endpoint does not exist in your organization. value: error: code: webhook_endpoint.not_found message: >- The webhook endpoint does not exist in your organization. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: >- https://docs.endstate.io/errors/webhook-endpoint-not-found '409': description: >- The request conflicts with the resource's current state. | Error code | When | | --- | --- | | `idempotency.in_progress` | A request with this `Idempotency-Key` is already in progress. | | `idempotency.key_conflict` | The `Idempotency-Key` was previously used with a different request body. | | `webhook_endpoint.disabled` | The webhook endpoint is disabled. Re-enable it with PATCH first. | x-error-codes: - idempotency.in_progress - idempotency.key_conflict - webhook_endpoint.disabled content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: idempotency.in_progress: summary: >- A request with this `Idempotency-Key` is already in progress. value: error: code: idempotency.in_progress message: >- A request with this `Idempotency-Key` is already in progress. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/idempotency-in-progress idempotency.key_conflict: summary: >- The `Idempotency-Key` was previously used with a different request body. value: error: code: idempotency.key_conflict message: >- The `Idempotency-Key` was previously used with a different request body. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/idempotency-key-conflict webhook_endpoint.disabled: summary: >- The webhook endpoint is disabled. Re-enable it with PATCH first. value: error: code: webhook_endpoint.disabled message: >- The webhook endpoint is disabled. Re-enable it with PATCH first. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: >- https://docs.endstate.io/errors/webhook-endpoint-disabled '410': description: >- The resource is gone: a consumed credential or a deleted endpoint. See the error code. | Error code | When | | --- | --- | | `webhook_endpoint.deleted` | The webhook endpoint was deleted and cannot be used for this operation. | x-error-codes: - webhook_endpoint.deleted content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: webhook_endpoint.deleted: summary: >- The webhook endpoint was deleted and cannot be used for this operation. value: error: code: webhook_endpoint.deleted message: >- The webhook endpoint was deleted and cannot be used for this operation. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/webhook-endpoint-deleted '429': description: |- Too many requests. | Error code | When | | --- | --- | | `rate_limit.exceeded` | Per-key rate limit exceeded. | x-error-codes: - rate_limit.exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rate_limit.exceeded: summary: Per-key rate limit exceeded. value: error: code: rate_limit.exceeded message: Per-key rate limit exceeded. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/rate-limit-exceeded '500': description: >- Something went wrong on our end. | Error code | When | | --- | --- | | `internal.error` | An unexpected server error occurred. Retry with exponential backoff and include `request_id` in any support request. | x-error-codes: - internal.error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal.error: summary: >- An unexpected server error occurred. Retry with exponential backoff and include `request_id` in any support request. value: error: code: internal.error message: >- An unexpected server error occurred. Retry with exponential backoff and include `request_id` in any support request. request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: https://docs.endstate.io/errors/internal-error security: - ApiKeyBearer: [] components: schemas: TestWebhookEndpointRequest: type: object properties: event_type: type: string minLength: 1 description: A type from the event catalog; its example payload is delivered. example: example.updated required: - event_type WebhookTestDelivery: type: object properties: event: $ref: '#/components/schemas/WebhookEvent' attempt: $ref: '#/components/schemas/WebhookDeliveryAttempt' required: - event - attempt ErrorResponse: type: object properties: error: type: object properties: code: anyOf: - $ref: '#/components/schemas/ErrorCode' - type: string description: >- Stable, namespaced error code. The `ErrorCode` catalogue lists every code defined today; handle an unrecognized value as a generic failure rather than throwing, since codes are added over time. example: chip.not_found message: type: string description: >- Human-readable description, for logs and debugging. Wording may change without notice - never parse or match against it. example: Chip not found request_id: type: string description: >- Identifier for this request, matching the `X-Request-Id` response header. Log it and include it in any support request. example: req_8e1a7f50-90ab-4cde-f012-3456789abcde doc_url: type: string description: Documentation page for this error code. example: https://docs.endstate.io/errors/chip-not-found details: $ref: '#/components/schemas/ValidationErrorDetails' required: - code - message - request_id - doc_url required: - error description: >- Every error response, regardless of endpoint or HTTP status, uses this envelope. WebhookEvent: type: object properties: id: type: string format: uuid description: Event id; also the `webhook-id` header on every delivery. example: 3f1c9a2b-7d4e-4f10-9a8b-2c6d5e4f3a21 type: type: string example: example.updated audience: type: string description: Which view of the resource the payload carries. example: brand api_version: type: string example: '2026-09-01' resource: type: object properties: type: type: string example: warranty id: type: string example: 6b1e2a3c-4d5e-4f60-8172-839405162738 revision: type: integer example: 1 required: - type - id - revision created_at: type: string format: date-time required: - id - type - audience - api_version - resource - created_at WebhookDeliveryAttempt: type: object properties: attempt: type: integer example: 1 status: type: string enum: - pending - succeeded - failed response_status_code: type: - integer - 'null' example: 200 duration_ms: type: - integer - 'null' example: 143 error: type: - string - 'null' next_attempt_at: type: - string - 'null' format: date-time created_at: type: string format: date-time endpoint: type: object properties: id: type: string format: uuid url: type: string deleted: type: boolean description: True when the endpoint has since been deleted. required: - id - url - deleted required: - attempt - status - response_status_code - duration_ms - error - next_attempt_at - created_at - endpoint ErrorCode: type: string enum: - environment.conflict - environment.invalid_configuration - organization.changed - validation.failed - auth.unauthorized - auth.forbidden - session_token.invalid_or_expired - session_token.wrong_chip - wallet_session.invalid_or_expired - not_found.resource - rate_limit.exceeded - chip.not_found - chip.invalid_e_value - chip.already_scanned - quota.exceeded - chip.not_a_test_chip - unit.not_found - unit.already_exists - unit.not_minted - collection.not_found - collection.already_exists - collection.not_active - collection_backfill.blocked - organization.not_found - chip.already_paired - chip.key_unusable - chip.mac_required - chip.bulk_mixed_collections - chip.bulk_pending - unit.issuance_pending - claim.owner_unknown - claim.already_to_recipient - claim.in_progress - claim.not_found - chip_replacement.locked - chip_replacement.in_progress - chip_replacement.not_found - transfer.owner_unknown - transfer.already_to_recipient - transfer.in_progress - transfer.not_found - submission.not_executable - vault.not_found - vault.already_exists - vault.provisioning_failed - vault.not_permitted - vault.unavailable - vault.challenge_invalid - vault.address_in_use - vault.key_conflict - vault.signer_unauthorized - vault_connection.not_found - vault_connection.not_active - vault_connection.already_exists - vault_connection.conflict - idempotency.key_conflict - idempotency.in_progress - internal.error - webhook_endpoint.not_found - webhook_endpoint.deleted - webhook_endpoint.limit_reached - webhook_endpoint.url_refused - webhook_endpoint.signing_unavailable - webhook_event_type.unknown - webhook_event.not_found - webhook_endpoint.disabled - webhook_delivery.in_progress - webhook_endpoint.not_subscribed description: >- Stable, namespaced error code in `.` form. Branch on this rather than on `message` or the HTTP status. This is the catalogue as of this spec revision, not a closed set - see `ErrorResponse.error.code`. example: chip.not_found ValidationErrorDetails: type: object properties: formErrors: type: array items: type: string description: Issues that apply to the request as a whole rather than one field. example: [] fieldErrors: type: object additionalProperties: type: array items: type: string description: Validation issues keyed by the field that failed. example: name: - Required required: - formErrors - fieldErrors description: Per-field validation detail. Present only on `validation.failed`. securitySchemes: ApiKeyBearer: type: http scheme: bearer bearerFormat: end_sk description: >- Use `Authorization: Bearer end_sk_*` for partner API keys (e.g. `end_sk_AbCd_example_api_key`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.