Type Alias Delivery

type Delivery = {
    eventType: string;
    id: string;
    request?: {
        body?: unknown;
        headers?: Record<string, string>;
        url?: string;
    };
    response?: {
        body?: string;
        headers?: Record<string, string>;
        statusCode?: number;
    };
    status: "success"
    | "fail";
    statusMessage?: string;
    triggeredAt: string;
    webhookId: string;
}
Index

Properties

eventType: string

The name of the triggering event-type.

id: string
request?: { body?: unknown; headers?: Record<string, string>; url?: string }

Type Declaration

  • Optionalbody?: unknown

    The sent body/payload of the delivery.

  • Optionalheaders?: Record<string, string>
  • Optionalurl?: string
response?: {
    body?: string;
    headers?: Record<string, string>;
    statusCode?: number;
}

Type Declaration

  • Optionalbody?: string

    The received body of the delivery.

  • Optionalheaders?: Record<string, string>
  • OptionalstatusCode?: number
status: "success" | "fail"
statusMessage?: string
triggeredAt: string
webhookId: string