v24

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-014382230.2 KB

Regenerate webhook secret

Generates a new signing secret for the webhook subscription. The old secret will immediately become invalid.

post/api/webhookSubscriptions.regenerateSecret

Request body

workspace_idstring required

The ID of the workspace

idstring required

The ID of the subscription

Example request

{
  "workspace_id": "ws_1234567890",
  "id": "whsub_a1b2c3d4e5f6"
}

Response

Webhook secret regenerated successfully

Example response

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