CreateWebhookEndpointBody

Request body for creating a WebhookEndpoint.

Definition

TypeScript

interface CreateWebhookEndpointBody {
  workspaceId: string;
  name: string;
  secret?: string | undefined;
  signatureHeader?: string | undefined;
  signatureAlgo?: "hmac-sha256" | "hmac-sha1" | undefined;
}

Fields

Field	Type	Notes
`workspaceId`	`string`	`required` — Workspace that will own the new endpoint.
`name`	`string`	`required` — Endpoint name
`secret`	`string \| undefined`	`optional` — Shared secret for signature verification
`signatureHeader`	`string \| undefined`	`optional` — Header name (e.g. X-Hub-Signature-256)
`signatureAlgo`	`"hmac-sha256" \| "hmac-sha1" \| undefined`	`optional` — Signature algorithm