Interface WebhookResponseMessage<TPayload>

The object representing a webhook response message.

Type Parameters

  • TPayload

Hierarchy

  • WebhookResponseMessage

Properties

errors? message_version? payload? warnings?

Properties

Optional errors

errors?: null | WebhookValidationResult[]

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.

Optional message_version

message_version?: "1.0"

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

Optional payload

payload?: null | TPayload

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

Optional warnings

warnings?: null | WebhookValidationResult[]

A warnings array to provide warning messages.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc