List webhook subscriptions

curl --request GET \
  --url https://{notifuseDomain}/api/webhookSubscriptions.list \
  --header 'Authorization: Bearer <token>'

{
  "subscriptions": [
    {
      "id": "whsub_a1b2c3d4e5f6",
      "name": "Production Webhook",
      "url": "https://api.example.com/webhooks/notifuse",
      "secret": "whsec_a1b2c3d4e5f6g7h8i9j0",
      "settings": {
        "event_types": [
          "contact.created",
          "contact.updated",
          "email.sent"
        ],
        "custom_event_filters": {
          "goal_types": [
            "purchase",
            "subscription"
          ],
          "event_names": [
            "orders/fulfilled",
            "payment.succeeded"
          ]
        }
      },
      "event_types": [
        "contact.created",
        "contact.updated",
        "email.sent"
      ],
      "custom_event_filters": {
        "goal_types": [
          "purchase",
          "subscription"
        ],
        "event_names": [
          "orders/fulfilled",
          "payment.succeeded"
        ]
      },
      "enabled": true,
      "last_delivery_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

GET

api

webhookSubscriptions.list

List webhook subscriptions

curl --request GET \
  --url https://{notifuseDomain}/api/webhookSubscriptions.list \
  --header 'Authorization: Bearer <token>'

{
  "subscriptions": [
    {
      "id": "whsub_a1b2c3d4e5f6",
      "name": "Production Webhook",
      "url": "https://api.example.com/webhooks/notifuse",
      "secret": "whsec_a1b2c3d4e5f6g7h8i9j0",
      "settings": {
        "event_types": [
          "contact.created",
          "contact.updated",
          "email.sent"
        ],
        "custom_event_filters": {
          "goal_types": [
            "purchase",
            "subscription"
          ],
          "event_names": [
            "orders/fulfilled",
            "payment.succeeded"
          ]
        }
      },
      "event_types": [
        "contact.created",
        "contact.updated",
        "email.sent"
      ],
      "custom_event_filters": {
        "goal_types": [
          "purchase",
          "subscription"
        ],
        "event_names": [
          "orders/fulfilled",
          "payment.succeeded"
        ]
      },
      "enabled": true,
      "last_delivery_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

API token for authentication

Query Parameters

workspace_id

string

required

The ID of the workspace

Response

List of webhook subscriptions

subscriptions

object[]

Show child attributes

subscriptions.id

string

Unique identifier for the subscription

Example:

"whsub_a1b2c3d4e5f6"

subscriptions.name

string

Human-readable name for the subscription

Example:

"Production Webhook"

subscriptions.url

string<uri>

The HTTPS URL to receive webhook events

Example:

"https://api.example.com/webhooks/notifuse"

subscriptions.secret

string

Secret key for signing webhook payloads (Standard Webhooks spec)

Example:

"whsec_a1b2c3d4e5f6g7h8i9j0"

subscriptions.settings

object

Settings for webhook subscription

Show child attributes

subscriptions.settings.event_types

string[]

List of event types this subscription is subscribed to

Example:

[
  "contact.created",
  "contact.updated",
  "email.sent"
]

subscriptions.settings.custom_event_filters

object

Optional filters for custom_event.* event types

Show child attributes

subscriptions.settings.custom_event_filters.goal_types

string[] | null

Filter by goal type (e.g., purchase, subscription, lead)

Example:

["purchase", "subscription"]

subscriptions.settings.custom_event_filters.event_names

string[] | null

Filter by event name (e.g., orders/fulfilled, payment.succeeded)

Example:

["orders/fulfilled", "payment.succeeded"]

subscriptions.event_types

string[]

List of event types this subscription is subscribed to (flattened from settings for convenience)

Example:

[
  "contact.created",
  "contact.updated",
  "email.sent"
]

subscriptions.custom_event_filters

object

Optional filters for custom_event.* event types (flattened from settings for convenience)

Show child attributes

subscriptions.custom_event_filters.goal_types

string[] | null

Filter by goal type (e.g., purchase, subscription, lead)

Example:

["purchase", "subscription"]

subscriptions.custom_event_filters.event_names

string[] | null

Filter by event name (e.g., orders/fulfilled, payment.succeeded)

Example:

["orders/fulfilled", "payment.succeeded"]

subscriptions.enabled

boolean

Whether the subscription is currently active

Example:

true

subscriptions.last_delivery_at

string<date-time> | null

Timestamp of the last delivery attempt

Example:

"2024-01-15T10:30:00Z"

subscriptions.created_at

string<date-time>

When the subscription was created

Example:

"2024-01-01T00:00:00Z"

subscriptions.updated_at

string<date-time>

When the subscription was last updated

Example:

"2024-01-15T10:30:00Z"

Create a webhook subscription Get a webhook subscription

⌘I

Transactional

Contacts

Lists

Custom Events

Broadcasts

Templates

Webhooks

List webhook subscriptions

Authorizations

Query Parameters

Response