Toggle webhook subscription enabled state

curl --request POST \
  --url https://{notifuseDomain}/api/webhookSubscriptions.toggle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "id": "whsub_a1b2c3d4e5f6",
  "enabled": true
}
'

{
  "subscription": {
    "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"
  }
}

POST

api

webhookSubscriptions.toggle

Toggle webhook subscription enabled state

curl --request POST \
  --url https://{notifuseDomain}/api/webhookSubscriptions.toggle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "id": "whsub_a1b2c3d4e5f6",
  "enabled": true
}
'

{
  "subscription": {
    "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

Body

application/json

workspace_id

string

required

The ID of the workspace

Example:

"ws_1234567890"

string

required

The ID of the subscription

Example:

"whsub_a1b2c3d4e5f6"

enabled

boolean

required

Whether to enable or disable the subscription

Example:

true

Response

Webhook subscription toggled successfully

subscription

object

A webhook subscription that receives HTTP callbacks when events occur

Show child attributes

subscription.id

string

Unique identifier for the subscription

Example:

"whsub_a1b2c3d4e5f6"

subscription.name

string

Human-readable name for the subscription

Example:

"Production Webhook"

subscription.url

string<uri>

The HTTPS URL to receive webhook events

Example:

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

subscription.secret

string

Secret key for signing webhook payloads (Standard Webhooks spec)

Example:

"whsec_a1b2c3d4e5f6g7h8i9j0"

subscription.settings

object

Settings for webhook subscription

Show child attributes

subscription.settings.event_types

string[]

List of event types this subscription is subscribed to

Example:

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

subscription.settings.custom_event_filters

object

Optional filters for custom_event.* event types

Show child attributes

subscription.settings.custom_event_filters.goal_types

string[] | null

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

Example:

["purchase", "subscription"]

subscription.settings.custom_event_filters.event_names

string[] | null

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

Example:

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

subscription.event_types

string[]

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

Example:

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

subscription.custom_event_filters

object

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

Show child attributes

subscription.custom_event_filters.goal_types

string[] | null

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

Example:

["purchase", "subscription"]

subscription.custom_event_filters.event_names

string[] | null

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

Example:

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

subscription.enabled

boolean

Whether the subscription is currently active

Example:

true

subscription.last_delivery_at

string<date-time> | null

Timestamp of the last delivery attempt

Example:

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

subscription.created_at

string<date-time>

When the subscription was created

Example:

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

subscription.updated_at

string<date-time>

When the subscription was last updated

Example:

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

Delete a webhook subscription Regenerate webhook secret

⌘I

Transactional

Contacts

Lists

Custom Events

Broadcasts

Templates

Webhooks

Toggle webhook subscription enabled state

Authorizations

Body

Response