Class EventSubscriptions

constructor

• new EventSubscriptions(fetch: FetchFunction): EventSubscriptions

  Create a new EventSubscriptions instance.

  Parameters

  • fetch: FetchFunction

    Function for making API requests

  Returns EventSubscriptions

Readonlydeliveries

create

• create(
      organizationId: number,
      body: CreateEventSubscriptionBody,
  ): Promise<CreatedEventSubscription>

  Create a new event subscription.

  Parameters

  • organizationId: number

    The organization ID to create the subscription in
  • body: CreateEventSubscriptionBody

    The subscription to create

  Returns Promise<CreatedEventSubscription>

  Promise with the created subscription and its signing secret

delete

• delete(organizationId: number, subscriptionId: string): Promise<void>

  Delete an event subscription. It stops receiving events immediately.

  Parameters

  • organizationId: number

    The ID of the organization that owns the subscription
  • subscriptionId: string

    The subscription ID to delete

  Returns Promise<void>

  Promise that resolves when the subscription is deleted

disable

• disable(
      organizationId: number,
      subscriptionId: string,
  ): Promise<EventSubscription>

  Disable an event subscription. Disabling an inactive subscription has no effect.

  Parameters

  • organizationId: number

    The ID of the organization that owns the subscription
  • subscriptionId: string

    The subscription ID to disable

  Returns Promise<EventSubscription>

  Promise with the disabled subscription

enable

• enable(
      organizationId: number,
      subscriptionId: string,
  ): Promise<EventSubscription>

  Enable an event subscription, including one that is suspended. Enabling an active subscription has no effect.

  Parameters

  • organizationId: number

    The ID of the organization that owns the subscription
  • subscriptionId: string

    The subscription ID to enable

  Returns Promise<EventSubscription>

  Promise with the enabled subscription

get

• get(organizationId: number, subscriptionId: string): Promise<EventSubscription>

  Get an event subscription and its current status.

  Parameters

  • organizationId: number

    The ID of the organization that owns the subscription
  • subscriptionId: string

    The subscription ID to retrieve

  Returns Promise<EventSubscription>

  Promise with the event subscription

list

• list(
      organizationId: number,
      options?: ListEventSubscriptionsOptions,
  ): Promise<EventSubscription[]>

  List the event subscriptions of an organization.

  Parameters

  • organizationId: number

    The organization ID to list event subscriptions for
  • Optionaloptions: ListEventSubscriptionsOptions

    Optional filtering, sorting, and pagination parameters

  Returns Promise<EventSubscription[]>

  Promise with the list of event subscriptions

listEventTypes

• listEventTypes(organizationId: number): Promise<EventSubscriptionEventType[]>

  List the event types a subscription in the organization can receive, with the JSON Schema of each payload version.

  Parameters

  • organizationId: number

    The organization ID to list event types for

  Returns Promise<EventSubscriptionEventType[]>

  Promise with the list of event types

update

• update(
      organizationId: number,
      subscriptionId: string,
      body: Partial,
  ): Promise<EventSubscription>

  Update an existing event subscription.

  Parameters

  • organizationId: number

    The ID of the organization that owns the subscription
  • subscriptionId: string

    The subscription ID to update
  • body: Partial

    The fields to update

  Returns Promise<EventSubscription>

  Promise with the updated subscription