HEherondata
Webhooks

Create a webhook

Changed on

Create a webhook

post/api/webhooks

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/webhooks
  • Auth
    API key in header x-api-key

Request body

Example request

{
  "webhook": {
    "headers": {
      "Content-Type": "application/json"
    },
    "heron_id": "wbh_QXwq4EGBC4NPYLMNGKv2JN",
    "is_enabled": true,
    "topic": "end_user.processed",
    "url": "https://www.your-webhook-endpoint.com/heron"
  }
}

Response

Created

Example response

{
  "webhook": {
    "headers": {
      "Content-Type": "application/json"
    },
    "heron_id": "wbh_QXwq4EGBC4NPYLMNGKv2JN",
    "is_enabled": true,
    "topic": "end_user.processed",
    "url": "https://www.your-webhook-endpoint.com/heron"
  }
}

Changes

  • bd8008e49534Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status