API ReferenceWebhooksUpdate Webhook

    Update Webhook

    Modify any existing properties of a registered webhook, including its endpoint URL and event subscriptions.
    PUThttps://wapi.simplysend.email/web-setup/webhooks/{webhookId}

    Parameters

    webhookIdRequired
    string
    The unique identifier of the webhook to update.
    name
    string
    The new friendly name for the webhook.
    url
    string
    The new delivery URL.
    isActive
    boolean
    Whether the webhook status is active or disabled.
    events
    array
    New list of subscribed event types. See the Valid Event Types overview for available options.
    headers
    object
    New custom key-value pairs to be included in the header of every webhook request.
    RequestPUT
    curl -X PUT https://wapi.simplysend.email/web-setup/webhooks/{webhookId} \
      -H "X-Api-Key: your_api_key" \
      -H "X-Id: your_account_id" \
      -H "Content-Type: application/json" \
      -d '{
      "name": "Production Analytics (Updated)",
      "url": "https://new-url.com/webhooks/simply-send",
      "isActive": true,
      "events": [
        "email_bounced"
      ]
    }'
    Response
    {
      "success": true,
      "data": {
        "message": "Webhook updated successfully",
        "webhook": {
          "webhookId": "webhook_1772354412494_02cb8b58",
          "name": "Production Analytics (Updated)",
          "url": "https://new-url.com/webhooks/simply-send",
          "isActive": true,
          "updatedAt": 1772354413068
        }
      }
    }