COcodatio
Webhooks

Create webhook consumer

Changed on

Use the Create webhook consumer endpoint to create a new webhook consumer that will listen to messages we send you.

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.

Tips and traps

  • The number of webhook consumers you can create is limited to 50. If you have reached the maximum number of consumers, use the Delete webhook consumer endpoint to delete an unused consumer first.
post/webhooks

Request

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

Request body

WebhookConsumerPrototype required(unresolved $ref)

Response

OK

idstring uuid

Unique identifier for the webhook consumer.

urlstring uri

The URL that will consume webhook events dispatched by Codat.

disabledboolean nullable

Flag that enables or disables the endpoint from receiving events. Disabled when set to true.

eventTypesstring[]

An array of event types the webhook consumer subscribes to.

companyTagsstring[] nullable

Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format tagKey:tagValue.

Example response

{
  "id": "8a210b68-6988-11ed-a1eb-0242ac120002"
}

Changes

  • e711c7acf8dfRevision changes
    • breaking

      the response property became nullable for the status

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      the request property became nullable

  • fd9017a95f3dRevision changes
    • info

      added the new optional request property