Webhooks

Create a new webhook endpoint

Changed on

Register a new webhook endpoint to receive event notifications

post/webhooks

Request

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

Request body

eventTypesstring[] nullable

Optional array of event types to subscribe to. Nothing means subscribe to all event types.

filterPathsstring[] nullable

Optional array of resource field paths to filter events by. When specified, webhook events will only be sent when one of these fields changes. Nothing means no filtering (all events are sent).

urlstring required

The URL to which webhook events will be delivered

Changes

  • ab652aa5aa8eRevision changes
    • breaking

      removed the enum value checkingAccount.availableBalance of the request property /

    • breaking

      removed the enum value checkingAccount.currentBalance of the request property /

    • breaking

      removed the enum value checkingAccount.inFlightBalance of the request property /

    • breaking

      removed the enum value creditAccount.availableBalance of the request property /

    • breaking

      removed the enum value creditAccount.currentBalance of the request property /

    • breaking

      removed the enum value creditAccount.inFlightBalance of the request property /

    • breaking

      removed the enum value investmentAccount.availableBalance of the request property /

    • breaking

      removed the enum value investmentAccount.currentBalance of the request property /

    • breaking

      removed the enum value investmentAccount.inFlightBalance of the request property /

    • breaking

      removed the enum value savingsAccount.availableBalance of the request property /

    • breaking

      removed the enum value savingsAccount.currentBalance of the request property /

    • breaking

      removed the enum value savingsAccount.inFlightBalance of the request property /

    • breaking

      removed the enum value treasuryAccount.availableBalance of the request property /

    • breaking

      removed the enum value treasuryAccount.currentBalance of the request property /

    • breaking

      removed the enum value treasuryAccount.inFlightBalance of the request property /

    • info

      media type application/json was changed to application/json;charset=utf-8 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