Trigger a sample webhook

post

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

Sends a sample payload of the chosen trigger to the configuration's URL, with its authorization and field naming, and records the delivery in webhook history. Answers 200 when the destination accepts it, and 400 with the reason when it does not, when the configuration is unknown or has no URL, or when the trigger cannot be tested. Only a 2xx counts as accepted: redirects are not followed, so a 3xx answers 400. The sample is sent once and never retried, whatever the configuration's retry settings; retries apply only to webhooks sent for real trigger events.

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 destination accepted the sample payload

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