Skip to content

webhookendpoint.md

Latest commit

 

History

History
38 lines (32 loc) · 6.2 KB

webhookendpoint.md

File metadata and controls

38 lines (32 loc) · 6.2 KB
Raw

WebhookEndpoint

A webhook endpoint.

Example Usage

import { WebhookEndpoint } from "@polar-sh/sdk/models/components/webhookendpoint.js";

let value: WebhookEndpoint = {
  createdAt: new Date("2026-11-07T23:32:02.142Z"),
  modifiedAt: new Date("2026-04-09T02:24:33.049Z"),
  id: "<value>",
  url: "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  format: "discord",
  secret: "whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK",
  organizationId: "<value>",
  events: [
    "member.updated",
  ],
  enabled: false,
};

Fields

Field Type Required Description Example
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
id string ✔️ The ID of the object.
url string ✔️ The URL where the webhook events will be sent. https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0
name string ➖ An optional name for the webhook endpoint to help organize and identify it.
format components.WebhookFormat ✔️ N/A
secret string ✔️ The secret used to sign the webhook events. whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK
organizationId string ✔️ The organization ID associated with the webhook endpoint.
events components.WebhookEventType[] ✔️ The events that will trigger the webhook.
enabled boolean ✔️ Whether the webhook endpoint is enabled and will receive events.