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
eventType id request? response? status statusMessage? triggeredAt webhookId
eventType: string

The name of the triggering event-type.

id: string

The delivery's unique identifier.

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

Request details for the delivery.

Type Declaration

  • Optionalbody?: unknown

    The sent body/payload of the delivery.

  • Optionalheaders?: Record<string, string>

    Headers sent for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.

  • Optionalurl?: string

    URL used for this delivery.

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

Response details for the delivery.

Type Declaration

  • Optionalbody?: string

    The received body of the delivery.

  • Optionalheaders?: Record<string, string>

    Headers received for this delivery, values of encryptedHeaders are omitted as such "OMITTED". Maximum size: 2048 bytes for non-encrypted headers + 2048 bytes for encrypted headers.

  • OptionalstatusCode?: number

    The HTTP status code of the response.

status: "success" | "fail"

The status of delivery.

statusMessage?: string

The status message of the delivery.

triggeredAt: string

The UTC timestamp when the delivery was triggered.

webhookId: string

The unique webhook identifier that the delivery is for.

Settings
Member Visibility

On This Page
Properties