Request a reset token for a webhook queue

post

https://{env}.gainsystems.com/api/v1/webhook/reset

Step 1 of 2 to discard webhooks that are queued but not yet delivered. Returns a token to pass to POST /api/v1/webhook/reset/confirm within 5 minutes. Answers 400 when a trigger or the ConfigurationId is unknown.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200The selected queue is empty, so no reset token was issued; Reason explains

201Reset token issued

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

500Unexpected server error

503GAINS is temporarily unavailable: GAINS X could not be reached or returned an error, a scheduled GAINS process is running, or your credentials could not be checked. Retry later

504GAINS X did not respond in time. Retry later