webhook

Get a webhook by ID

get/v1/webhook/{webhookId}

Path parameters

webhookIdstring required

Public webhook ID returned by Create Webhook.

Response

Webhook fetched successfully

{"stackTrail":"paths:/v1/webhook/{webhookId}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Webhook fetched successfully","payload":{"id":"69fb3ac1eda582171eb74826","name":"Email Sent Webhook","webhookUrl":"https://example.org/webhooks/email-sent","webhookEvent":["email-sent"],"headers":{"X-Webhook-Source":"saleshandy"},"status":"paused","failed":true,"lastFailure":{"failedAt":"2026-04-21T11:04:57.090Z","statusCode":404,"message":"Delivery failed"}}}}

Example response

{
  "message": "Webhook fetched successfully",
  "payload": {
    "id": "69fb3ac1eda582171eb74826",
    "name": "Email Sent Webhook",
    "webhookUrl": "https://example.org/webhooks/email-sent",
    "webhookEvent": [
      "email-sent"
    ],
    "headers": {
      "X-Webhook-Source": "saleshandy"
    },
    "status": "paused",
    "failed": true,
    "lastFailure": {
      "failedAt": "2026-04-21T11:04:57.090Z",
      "statusCode": 404,
      "message": "Delivery failed"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.