webhook

Get a webhook by ID

get/v1/webhook/{webhookId}

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/webhook/:webhookId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

webhookIdstring required

Public webhook ID returned by Create Webhook.

Response

Webhook fetched successfully

unknown required

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 operation across all 4 revisions of this API.