PolarExpress.Schemas.WebhookEndpointCreate (polar_express v0.2.2)

Copy Markdown View Source

WebhookEndpointCreate

Schema to create a webhook endpoint.

Summary

Types

t()

@type t() :: %PolarExpress.Schemas.WebhookEndpointCreate{
  events: term(),
  format: term(),
  name: term(),
  organization_id: term(),
  url: term()
}
  • events - The events that will trigger the webhook.
  • format - The format of the webhook payload.
  • name - An optional name for the webhook endpoint to help organize and identify it. Nullable.
  • organization_id - The organization ID associated with the webhook endpoint. Required unless you use an organization token. Nullable.
  • url - The URL where the webhook events will be sent. Format: uri. Max length: 2083.

Functions

schema_name()