Interface WebhookResponseMessage<TPayload>

The object representing a webhook response message.

interface WebhookResponseMessage<TPayload> {
    errors?: WebhookValidationResult[] | null;
    message_version?: "1.0";
    payload?: TPayload | null;
    warnings?: WebhookValidationResult[] | null;
}

Properties

If webhook needs to respond with an error - at least one error object must be provided and payload must be omitted or set to null.

message_version?: "1.0"

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

payload?: TPayload | null

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

A warnings array to provide warning messages.