POST /webhooks/registrations

Register a webhook

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
topic String Yes

Valid values: listings/update, listings/publish, listings/bumps-ran-out, orders/create, orders/update, payments/create, payments/update, app/uninstalled

Valid values:

  • "orders/create"
  • "payments/create"
  • "listings/bumps-ran-out"
  • "orders/update"
  • "listings/update"
  • "payments/update"
  • "app/uninstalled"
  • "listings/publish"
url String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.