Get Webhooks

Retrieves a list of webhook events based on an eventID filter. You can apply filters to narrow down the response.

Supported eventID values:

  • ORDER_CREATED
  • ORDER_PROCESSING
  • ORDER_PAYMENT_VERIFYING
  • ORDER_COMPLETED
  • ORDER_FAILED
  • ORDER_CANCELLED
<Callout intent="note"> To fetch relevant data, provide `orderID` along with the `eventID` filter. </Callout>
get/webhooks

Request

  • Base URL: https://api-stg.transak.com/partners/api/v2
  • URL: https://api-stg.transak.com/partners/api/v2/webhooks
  • Auth: none declared. Required headers: x-api-key, access-token

Query parameters

eventIDstring

Filter by event id (ORDER_COMPLETED, ORDER_CANCELLED, ORDER_CREATED, ORDER_FAILED, ORDER_PROCESSING,ORDER_PAYMENT_VERIFYING))

orderIDstring

Filter by order id

limitinteger

limits the number of records returned.

skipinteger

skip omits the specified number of returned records

startDatestring

startDate in YYYY-MM-DD format. Filters by createdAt from this date.

endDatestring

endDate in YYYY-MM-DD format. Filters by createdAt up to this date.

statusstring

Filter by delivery outcome. Supported values are success and failed.

Headers

x-api-keystring required

Your Partner API key. You can find this in the Partner Dashboard.

access-tokenstring required

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Response

200

Changes

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