webhooks

Send a test delivery

Queue a webhook.test event to this endpoint: a real signed delivery through the same path live events use, so what it proves is what production will do. The answer is 202 and the delivery's id — the delivery itself has not happened yet. Read its outcome from the endpoint's delivery log.

post/webhooks/{id}/test

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/webhooks/{id}/test
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Response

Send a test delivery

deliveryIdstring required

Look this up in GET /webhooks/{id}/deliveries to see what the receiver answered.

eventIdstring required

Sent as Gogoscreen-Event-Id.

Changes

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