WebhookEndpoint

The `WebhookEndpoint` entity.

Definition

TypeScript

interface WebhookEndpoint {
  id: string;
  workspaceId: string;
  name: string;
  signatureHeader: string | null;
  signatureAlgo: string | null;
  enabled: boolean;
  createdBy: string;
  createdAt: string;
  updatedAt: string;
}

Fields

Field	Type	Notes
`id`	`string`	`readonly` `required`
`workspaceId`	`string`	`required` — Workspace that owns this inbound endpoint.
`name`	`string`	`required` — Human-readable endpoint label.
`signatureHeader`	`string \| null`	`required` — HTTP header carrying the signature, if verification is enabled.
`signatureAlgo`	`string \| null`	`required` — Signature algorithm (e.g. 'hmac-sha256'), if verification is enabled.
`enabled`	`boolean`	`required` — When false the endpoint is registered but rejects requests.
`createdBy`	`string`	`required` — User who created the endpoint.
`createdAt`	`string`	`readonly` `required` — ISO-8601 timestamp of creation.
`updatedAt`	`string`	`readonly` `required` — ISO-8601 timestamp of the last update.