Interface WebhookRequestMessage<TPayload>

The object representing a webhook request message.

interface WebhookRequestMessage<TPayload> {
    message_id: string;
    message_type: string;
    message_version: string;
    payload: TPayload;
    timestamp: string;
}

Properties

message_id: string

A unique message ID. This can be used for logging or potentially be remembered to avoid replay attacks.

message_type: string

A message type to distinguish the action that should be performed on the webhook server side.

message_version: string

A message version that defines the version of the message structure.

payload: TPayload

Generic payload JSON object that contains the actual business-relevant data.

timestamp: string

A UTC-based ISO timestamp when the webhook call was made. By default, calls where the date is older than 120 seconds will be rejected.