Skip to main content
WEBHOOK

Authorizations

​
Authorization
string
header
required

Your Moonbase API key.

Headers

​
webhook-id
string
required

The unique ID of the service event that triggered the notification. This value starts with msg_ and is identical for all retries of a given notification.

​
webhook-timestamp
integer
required

The timestamp when the notification request was sent, as seconds since the Unix epoch. Use this value to verify that the notification was sent recently.

​
webhook-signature
string
required

A generated signature that you can use to verify the authenticity of the notification.

Body

application/json

The activity details.

Represents an event that occurs when a ProgramMessage fails to be delivered for a technical reason.

​
id
string
required

Unique identifier for the object.

​
occurred_at
string<date-time>
required

The time at which the event occurred, as an ISO 8601 timestamp in UTC.

​
type
string
required

The type of activity. Always activity/program_message_failed.

Allowed value: "activity/program_message_failed"
​
program_message
null | ProgramMessagePointer · object
required

The ProgramMessage associated with the event.

​
recipient
null | ItemPointer · object
required

A link to the Address of the recipient whose message failed.

​
reason_code
enum<string>

A code indicating the reason for the failure (e.g., message_contained_virus).

Available options:
liquid_error,
person_missing_email,
message_contained_virus

Response

200

Successful response.