Webhooks
Send a ping test event to the endpoint
Operation ID: testWebhook
POST
Queues one ping message to the endpoint, signed like any event, and answers 202 at once; the delivery happens shortly after. A ping is sent once and not retried. Calling this again for the same endpoint within 10 seconds is a 429 rate_limited.
Needs an API key with the manage scope.
apiKeyheader
AuthorizationBearer <oq_ followed by 43 letters and digits>An Outqube API key, made in the app's settings. It belongs to one app and has the scope read, trigger or manage; a higher scope includes the lower ones. A revoked or expired key is a 401.
webhookId*stringThe endpoint's id.
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidAccepted
application/json- response
delivery_id*stringThe delivery's id in the endpoint's delivery log.
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidmessage_id*stringThe webhook-id header of the test message: ping_ and a UUID.
curl -X POST 'https://app.outqube.com/api/v1/webhooks/d8f0b2a4-6c1e-4d73-9a5b-1c3e5a7b9d46/test'Example Response
{ "delivery_id": "62a8c4e0-f1b3-4d57-8e9a-0b2d4f6a8c13", "message_id": "ping_0f6c2e8a-4b1d-4a73-9c5e-7d3b1a9f2e68"}