Skip to content

Webhooks API

List webhooks

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

Rate limits

Burst: 1/s

Steady: 15/m

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

Scopes

webhooks:read

Operation id

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

Query parameters

array of strings

Attributes of webhook-topic resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of webhook resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Related resources to side-load.

Includes guide

Pick values to add them to the request:

Headers

stringrequireddefault 2026-10-15

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

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    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: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • metaobject

  • includedarray of objects

    included: 3 fields
    • typestringrequired

      webhook-topic
    • idstringrequired

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

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