Webhooks

Send a test event

Send a test webhook.test event to the endpoint.

post/webhooks/{id}/test

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/webhooks/{id}/test
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Test event queued.

event_idstring required

ID of the test event.

Example response

{
  "event_id": "evt_abc123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.