Skip to main content
WEBHOOK
activity
/
program_message_shielded
{
  "id": "1CLJt2v4aqpedDUrD4GJ2N",
  "occurred_at": "2025-02-17T16:00:00.000Z",
  "type": "activity/program_message_shielded",
  "program_message": {
    "id": "1CLJt2v4LTd2iVzVWmBhub",
    "type": "program_message"
  },
  "recipient": {
    "id": "1CLJt2v17V1yuCdrUwA4PW",
    "type": "item",
    "collection": {
      "id": "1CLJt2ubZ7zAZFBxUxeBHo",
      "type": "collection",
      "ref": "people"
    }
  },
  "reason_code": "person_previously_unsubscribed"
}

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 is prevented from being sent by a delivery protection rule.

​
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_shielded.

Allowed value: "activity/program_message_shielded"
​
program_message
Pointer · object
required

The ProgramMessage associated with the event.

​
recipient
ItemPointer · object
required

A link to the Address of the recipient whose message was shielded.

​
reason_code
string

A code indicating why the message was shielded (e.g., person_previously_unsubscribed).

Response

200

Successful response.