Retrieve historical issued webhooks

get

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

Lists webhook delivery attempts: a webhook that was retried appears once per attempt, with the HTTP status the destination answered. Payloads are left out unless WithPayload is true. See Delivery & Recovery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

SearchDateStart

string

Earliest issue time to include, yyyy-MM-dd HH:mm:ss in server time. Defaults to the start of today.

SearchDateEnd

string

Issue time to stop before (exclusive), yyyy-MM-dd HH:mm:ss in server time. Defaults to the end of today. Must not be earlier than SearchDateStart.

Status

string

Filter by status - success, failed, no_response. Defaults to all. One value, case-insensitive.

TrackingNumber

string

Only deliveries whose payload contains this order tracking number (POSubmit, TOSubmit, WOSubmit, ProductionOrderSubmit). Positive integer. Matches deliveries sent with either field naming, PASCAL_CASE or CAMEL_CASE.

Trigger

string

Only deliveries of these triggers, comma-separated, for example POSubmit,TOSubmit. Defaults to all triggers. Values are the trigger names listed by GET /api/v1/webhook/triggers, case-insensitive; an unknown trigger is rejected with 400.

WithPayload

boolean

Include the delivered payload with each history entry

Cursor

string

Opaque cursor identifying the page to return. Omit for the first page, then pass the NextCursor value from the previous response

Size

integer

1 to 1000

Defaults to 100

Maximum number of records to return in one page, from 1 to 1000. Default 100. On endpoints that group records under an item (for example, policies and forecasts), the limit applies to item/location records, so a page can return fewer top-level items than Size

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

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

*/*

application/json

200Request succeeded

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