Class EventSubscriptionDeliveries

Class providing methods for working with the deliveries of Make event subscriptions.

A delivery is one event sent to a subscription. Delivery details include the event's data and the endpoint's responses.

Index

Constructors

Methods

get list resend

Constructors

constructor

new EventSubscriptionDeliveries(
fetch: FetchFunction,
): EventSubscriptionDeliveries
Create a new EventSubscriptionDeliveries instance.
Parameters
- fetch: FetchFunction
  Function for making API requests
Returns EventSubscriptionDeliveries
- Defined in src/endpoints/event-subscription-deliveries.ts:170

Methods

get

get(
    organizationId: number,
    subscriptionId: string,
    deliveryId: string,
): Promise<EventSubscriptionDeliveryDetail>
Get a delivery with the event that was sent and every attempt to send it.
Parameters
- organizationId: number
  The ID of the organization that owns the subscription
- subscriptionId: string
  The ID of the subscription the delivery belongs to
- deliveryId: string
  The delivery ID to retrieve
Returns Promise<EventSubscriptionDeliveryDetail>
Promise with the delivery detail
- Defined in src/endpoints/event-subscription-deliveries.ts:208

list

list(
    organizationId: number,
    subscriptionId: string,
    options?: ListEventSubscriptionDeliveriesOptions,
): Promise<EventSubscriptionDelivery[]>
List the deliveries of an event subscription.
Parameters
- organizationId: number
  The ID of the organization that owns the subscription
- subscriptionId: string
  The subscription ID to list deliveries for
- Optionaloptions: ListEventSubscriptionDeliveriesOptions
  Optional filtering, sorting, and pagination parameters
Returns Promise<EventSubscriptionDelivery[]>
Promise with the list of deliveries
- Defined in src/endpoints/event-subscription-deliveries.ts:181

resend

resend(
    organizationId: number,
    subscriptionId: string,
    deliveryId: string,
): Promise<EventSubscriptionDeliveryResend>
Send a delivery's event to the endpoint again as a new, manual attempt. The result confirms that the resend was accepted, not that it succeeded; get the delivery to see the outcome.
Parameters
- organizationId: number
  The ID of the organization that owns the subscription
- subscriptionId: string
  The ID of the subscription the delivery belongs to
- deliveryId: string
  The delivery ID to resend
Returns Promise<EventSubscriptionDeliveryResend>
Promise with the accepted resend
- Defined in src/endpoints/event-subscription-deliveries.ts:228