Webhooks

Get webhook endpoints

Changed on

Retrieve a paginated list of all webhook endpoints for your organization. Supports filtering by status.

get/webhooks

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/webhooks
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

statusstring[]
limitinteger

Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000

start_afterstring uuid

The ID of the webhook to start the page after (exclusive). When provided, results will begin with the webhook immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.

end_beforestring uuid

The ID of the webhook to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.

order'asc' | 'desc'

Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'

Changes

  • ab652aa5aa8eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      media type application/json was changed to application/json;charset=utf-8 for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed the checkingAccount.availableBalance enum value from the /// response property for the response status

    • info

      removed the checkingAccount.currentBalance enum value from the /// response property for the response status

    • info

      removed the checkingAccount.inFlightBalance enum value from the /// response property for the response status

    • info

      removed the creditAccount.availableBalance enum value from the /// response property for the response status

    • info

      removed the creditAccount.currentBalance enum value from the /// response property for the response status

    • info

      removed the creditAccount.inFlightBalance enum value from the /// response property for the response status

    • info

      removed the investmentAccount.availableBalance enum value from the /// response property for the response status

    • info

      removed the investmentAccount.currentBalance enum value from the /// response property for the response status

    • info

      removed the investmentAccount.inFlightBalance enum value from the /// response property for the response status

    • info

      removed the savingsAccount.availableBalance enum value from the /// response property for the response status

    • info

      removed the savingsAccount.currentBalance enum value from the /// response property for the response status

    • info

      removed the savingsAccount.inFlightBalance enum value from the /// response property for the response status

    • info

      removed the treasuryAccount.availableBalance enum value from the /// response property for the response status

    • info

      removed the treasuryAccount.currentBalance enum value from the /// response property for the response status

    • info

      removed the treasuryAccount.inFlightBalance enum value from the /// response property for the response status