Skip to main content
GET
/
api
/
webhookSubscriptions.get
Get a webhook subscription
curl --request GET \
  --url https://{notifuseDomain}/api/webhookSubscriptions.get \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.notifuse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API token for authentication

Query Parameters

​
workspace_id
string
required

The ID of the workspace

​
id
string
required

The ID of the webhook subscription

Response

Webhook subscription found

​
subscription
object

A webhook subscription that receives HTTP callbacks when events occur