Skip to content

Webhooks API

Create a webhook

POSThttps://email.growthdept.ai/api/webhooks

The request body can be up to 5 MB.

Rate limits

Burst: 1/s

Steady: 15/m

Tier XS. See rate limits for how requests are counted.

Scopes

webhooks:write

Operation id

create_webhook The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of webhook resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      webhook
    • idstring

    • attributesobjectrequired

      attributes: 4 fields
      • namestringrequired

      • descriptionstringcan be null

      • endpoint_urlstringrequired

      • secret_keystringrequired

    • relationshipsobject

      relationships: 1 field
      • webhook-topicsobjectrequired

        webhook-topics: 1 field
        • dataarray of objectsrequired

          data: 2 fields
          • typestringrequired

            webhook-topic
          • idstringrequired

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

201Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      webhook
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringrequired

      • descriptionstringcan be null

      • endpoint_urlstringrequired

      • enabledbooleanrequired

      • created_atstring (date-time)can be null

      • updated_atstring (date-time)can be null

    • relationshipsobject

      relationships: 1 field
      • webhook-topicsobject

        webhook-topics: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            webhook-topic
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject