Webhooks

List webhook consumers

Changed on

Use the List webhook consumers endpoint to return a list of all webhook consumers that currently exist for your client.

Webhook consumer is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on Codat's webhook service.

get/webhooks

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/webhooks
  • Auth
    API key in header Authorization

Response

OK

WebhookConsumers required(unresolved $ref)

Changes

    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      response property results/items/companyId deprecated