Send a test event

POST 
/webhook_endpoints/:external_id/test

Sends a real, signed example event (fake values) using the production envelope, signature scheme, and transport, and reports the outcome inline. Does not affect delivery health. Rate-limited to 10 per minute per endpoint. Investor email appears in the example only if your application holds read:investors:pii, matching what real deliveries can carry.

Request

Responses

200

Test outcome

401

Authentication required or token is invalid/expired. This error occurs when:

• No Authorization header is provided
• The access token is invalid or malformed
• The access token has expired
• The access token has been revoked

To resolve: Obtain a new access token using the OAuth 2.0 flow.

403

The authenticated user does not have permission to access this resource. This typically means:

• The user is authenticated but lacks the required OAuth scope
• The resource belongs to a different user
• The user's role doesn't allow this operation

Check that your OAuth token includes the necessary scopes for this endpoint.

404

The requested resource does not exist or is not visible to this token.

422

Endpoint is not subscribed to the event, or the event has no example

429

Too many requests in a short time period. The API enforces rate limits to ensure fair usage and system stability. When you exceed the limit, you'll receive this error along with headers indicating when you can retry.

Check the X-RateLimit-Reset header to know when your limit will reset. Consider implementing exponential backoff in your application.

Response Headers

X-RateLimit-Limit

Request limit per hour

X-RateLimit-Remaining

Remaining requests

X-RateLimit-Reset

UTC timestamp when the limit resets