Reference

BackstageClient.webhookDeliveries

BackstageClient.webhookDeliveries in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / webhookDeliveries

webhookDeliveries: {
  get: (deliveryId: string, requestOptions?: RequestOptions) => Promise<{
     attempts: number;
     createdAt: string;
     deliveredAt: string | null;
     endpointId: string;
     error: string | null;
     eventType: string;
     id: string;
     lastAttemptAt: string | null;
     nextAttemptAt: string | null;
     responseStatus: number | null;
     sourceEventId: string;
     status: "succeeded" | "failed" | "pending";
  }>;
  list: (options?: {
     endpointId?: string;
     limit?: number;
   }, requestOptions?: RequestOptions) => Promise<{
     attempts: number;
     createdAt: string;
     deliveredAt: string | null;
     endpointId: string;
     error: string | null;
     eventType: string;
     id: string;
     lastAttemptAt: string | null;
     nextAttemptAt: string | null;
     responseStatus: number | null;
     sourceEventId: string;
     status: "succeeded" | "failed" | "pending";
  }[]>;
  listInbound: (requestOptions?: RequestOptions) => Promise<{
     attempts: number;
     error: string | null;
     eventType: string | null;
     id: string;
     normalisedType: string | null;
     organisationId: string | null;
     processedAt: string | null;
     provider: string;
     receivedAt: string;
     status: "failed" | "processed" | "received";
     verified: boolean;
  }[]>;
};

Defined in: client.ts:10535

Webhook Deliveries methods

get()#

get: (deliveryId: string, requestOptions?: RequestOptions) => Promise<{
  attempts: number;
  createdAt: string;
  deliveredAt: string | null;
  endpointId: string;
  error: string | null;
  eventType: string;
  id: string;
  lastAttemptAt: string | null;
  nextAttemptAt: string | null;
  responseStatus: number | null;
  sourceEventId: string;
  status: "succeeded" | "failed" | "pending";
}>;

Get a webhook delivery

Parameters#

Parameter	Type
`deliveryId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ attempts: number; createdAt: string; deliveredAt: string | null; endpointId: string; error: string | null; eventType: string; id: string; lastAttemptAt: string | null; nextAttemptAt: string | null; responseStatus: number | null; sourceEventId: string; status: "succeeded" | "failed" | "pending"; }>

Operation Id#

getWebhookDelivery

list()#

list: (options?: {
  endpointId?: string;
  limit?: number;
}, requestOptions?: RequestOptions) => Promise<{
  attempts: number;
  createdAt: string;
  deliveredAt: string | null;
  endpointId: string;
  error: string | null;
  eventType: string;
  id: string;
  lastAttemptAt: string | null;
  nextAttemptAt: string | null;
  responseStatus: number | null;
  sourceEventId: string;
  status: "succeeded" | "failed" | "pending";
}[]>;

List webhook deliveries The delivery log - every attempt, its status, response and retry schedule.

Parameters#

Parameter	Type
`options?`	{ `endpointId?`: `string`; `limit?`: `number`; }
`options.endpointId?`	`string`
`options.limit?`	`number`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listWebhookDeliveries

listInbound()#

listInbound: (requestOptions?: RequestOptions) => Promise<{
  attempts: number;
  error: string | null;
  eventType: string | null;
  id: string;
  normalisedType: string | null;
  organisationId: string | null;
  processedAt: string | null;
  provider: string;
  receivedAt: string;
  status: "failed" | "processed" | "received";
  verified: boolean;
}[]>;

List recent inbound webhook events (ingress log)

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ attempts: number; error: string | null; eventType: string | null; id: string; normalisedType: string | null; organisationId: string | null; processedAt: string | null; provider: string; receivedAt: string; status: "failed" | "processed" | "received"; verified: boolean; }[]>

Operation Id#

listInboundWebhooks