# Email compliance events

Contains event body information specific to email compliance events.


## Email bounce event {#bounce}

An event that occurs when an email could not be delivered to a particular address. The `bounce_class` can provide more information about why the message bounced.


[Jump to examples ↓](#bounce-examples)

- **`body`** `object` **REQUIRED**

  Contains the event subtype and additional properties about the event.

  **OBJECT PROPERTIES**

  - **`event_type`** `string` **REQUIRED**

    Possible values: `bounce`

  - **`identifiers`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`address`** `string`

      The email address registered.

  - **`properties`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`bounce_class`** `integer`

      The bounce classification as specified in SparkPost.

      Min: 1, Max: 100

    - **`bounce_event_type`** `string`

      Possible values: `bounce`

    - **`email`** `string`

      The email address that bounced.

      Format: `email`

    - **`sender`** `string`

      The address that the bounced email came from (typically the sender address for your project in Airship).

    - **`subject`** `string`

      The subject line of the bounced email.

- **`device`** `object` **REQUIRED**

  Holds information about the email `device` (an individual email channel) the event occurred against.

  **OBJECT PROPERTIES**

  - **`channel`** `string`

    The unique, platform-agnostic channel identifier for a device.

  - **`delivery_address`** `string` **REQUIRED**

    The email address of the channel the event occurred against.

  - **`device_type`** `string` **REQUIRED**

    Email compliance events use the `EMAIL` device type.

    Possible values: `EMAIL`

  - **`named_user`** `string`

    The Named User that the channel is associated with; appears only if the channel is associated with a Named User.


**Used in:**

- [Open a compliance event stream]({{< ref "/developer/rest-api/connect/operations/compliance-event-stream/" >}}#opencomplianceeventstream)
- [Open an event stream]({{< ref "/developer/rest-api/connect/operations/event-stream/" >}}#openeventstream)

**Examples**

*Example email bounce event*

```json
{
    "id": "9781ff2e-fa4a-4fa8-bd9d-41f318c48963",
    "offset": "1000001778910",
    "occurred": "2018-11-28T00:02:41.794Z",
    "processed": "2018-11-28T00:02:45.270Z",
    "device": {
        "channel": "5a39b6d8-0a5a-4c2b-a4a0-3d4a71e5254b",
        "device_type": "EMAIL",
        "delivery_address": "bademail@example.com"
    },
    "body": {
        "event_type": "bounce",
        "properties": {
            "bounce_event_type": "bounce",
            "sender": "msprvs1=17870ayYKWpBI=bounces-179492-4@example.com",
            "subject": "Red Means Go",
            "email": "bademail@example.com",
            "bounce_class": "10"
        }
    },
    "type": "COMPLIANCE"
}

```

---

## Email Create and Send event {#emailcreateandsend}

An event that occurs for email addresses used as a part of a [Create and Send](/docs/guides/audience/segmentation/bulk-sending/).

[Jump to examples ↓](#emailcreateandsend-examples)

- **`body`** `object` **REQUIRED**

  Contains the event subtype and additional properties about the event.

  **OBJECT PROPERTIES**

  - **`event_type`** `string` **REQUIRED**

    Possible values: `create_and_send`

  - **`identifiers`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`address`** `string` **REQUIRED**

      The email address a message was sent to using Create and Send.

  - **`properties`** `object` **REQUIRED**

    Properties for an email [Create and Send](/docs/guides/audience/segmentation/bulk-sending/) event.

    **OBJECT PROPERTIES**

    - **`channel_registered`** `boolean` **REQUIRED**

      If true, a new channel was created to represent the identifiers in the event. If false, the address was already registered to Airship.

    - **`commercial_opted_in`** `string`

      The date and time when the `address` opted into commercial email messages.

    - **`transactional_opted_in`** `string`

      The date and time when the `address` opted into transactional email messages.

- **`device`** `object` **REQUIRED**

  Holds information about the email `device` (an individual email channel) the event occurred against.

  **OBJECT PROPERTIES**

  - **`channel`** `string`

    The unique, platform-agnostic channel identifier for a device.

  - **`delivery_address`** `string` **REQUIRED**

    The email address of the channel the event occurred against.

  - **`device_type`** `string` **REQUIRED**

    Email compliance events use the `EMAIL` device type.

    Possible values: `EMAIL`

  - **`named_user`** `string`

    The Named User that the channel is associated with; appears only if the channel is associated with a Named User.


**Used in:**

- [Open a compliance event stream]({{< ref "/developer/rest-api/connect/operations/compliance-event-stream/" >}}#opencomplianceeventstream)
- [Open an event stream]({{< ref "/developer/rest-api/connect/operations/event-stream/" >}}#openeventstream)

**Examples**

*Example email Create and Send event*

```json
{
    "id": "adf8794c-c3c3-4507-9ea3-1a554ed4b94f",
    "offset": "1000001778141",
    "occurred": "2018-11-27T23:20:12.167Z",
    "processed": "2018-11-27T23:20:12.443Z",
    "device": {
        "channel": "b8519372-54ff-456d-9819-7faa92fe8b9d",
        "device_type": "EMAIL",
        "delivery_address": "new.address@example.com"
    },
    "body": {
        "event_type": "create_and_send",
        "identifiers": {
            "address": "new.address@example.com"
        },
        "properties": {
            "channel_registered": "true",
            "commercial_opted_in": "2018-10-12T12:12:12"
        }
    },
    "type": "COMPLIANCE"
  }

```

---

## Email registration event {#registration}

An event that occurs when users register to receive email messages.

[Jump to examples ↓](#registration-examples)

- **`body`** `object` **REQUIRED**

  Contains the event subtype and additional properties about the event.

  **OBJECT PROPERTIES**

  - **`event_type`** `string` **REQUIRED**

    Possible values: `registration`

  - **`identifiers`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`address`** `string`

      The email address registered.

  - **`properties`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`commercial_opted_in`** `string`

      The date and time when the user opted into commercial email messages.

    - **`registration_type`** `string` **REQUIRED**

      `create` indicates that a channel was created in Airship. `update` represents a `PUT` call to the email channel registration API.


      Possible values: `create`, `unbounce`, `update`, `opt_in`, `unsubscribe`

    - **`source`** `string`

      Only appears when [suppression is removed from an email channel using the dashboard Contact Management tool](/docs/guides/audience/contact-management/#removing-email-suppression).

      Possible values: `ui`

    - **`suppression_state`** `string`

      The suppression state of the email address.

      Possible values: `imported`, `spam_complaint`, `commercial_spam_complaint`, `out_of_band`, `bounce`, `none`

    - **`user`** `string`

      The username of the Airship dashboard user that [removed suppression from an email channel using the dashboard Contact Management tool](/docs/guides/audience/contact-management/#removing-email-suppression) and acknowledged the compliance implications.

- **`device`** `object` **REQUIRED**

  Holds information about the email `device` (an individual email channel) the event occurred against.

  **OBJECT PROPERTIES**

  - **`channel`** `string`

    The unique, platform-agnostic channel identifier for a device.

  - **`delivery_address`** `string` **REQUIRED**

    The email address of the channel the event occurred against.

  - **`device_type`** `string` **REQUIRED**

    Email compliance events use the `EMAIL` device type.

    Possible values: `EMAIL`

  - **`named_user`** `string`

    The Named User that the channel is associated with; appears only if the channel is associated with a Named User.


**Used in:**

- [Open a compliance event stream]({{< ref "/developer/rest-api/connect/operations/compliance-event-stream/" >}}#opencomplianceeventstream)
- [Open an event stream]({{< ref "/developer/rest-api/connect/operations/event-stream/" >}}#openeventstream)

**Examples**

*Example email registration event*

```json
{
    "id": "8058bfd3-9081-4f48-845c-809bf5462ca4",
    "offset": "1000000739139",
    "occurred": "2018-12-18T21:24:11.836Z",
    "processed": "2018-12-18T21:24:12.608Z",
    "device": {
        "channel": "93f32fb8-0e40-440b-8944-2f9ef933ca88",
        "device_type": "EMAIL"
    },
    "body": {
        "event_type": "registration",
        "identifiers": {
            "address": "new.user@example.com"
        },
        "properties": {
            "commercial_opted_in": "2018-10-20T12:00:00.000Z",
            "registration_type": "create"
        }
    },
    "type": "COMPLIANCE"
  }

```

*Example email suppression removal event*

```json
{
  "id": "d7ece0e7-b160-49ff-974d-2fd4dd5b34fd",
  "offset": "1000000287040",
  "occurred": "2026-03-12T19:45:00.620Z",
  "processed": "2026-03-12T19:45:02.065Z",
  "device": {
    "channel": "e839cdb5-4b79-4652-ab94-b1ac84294f3f",
    "device_type": "EMAIL",
    "delivery_address": "some.user@example.com"
  },
  "body": {
    "event_type": "registration",
    "identifiers": {
      "address": "some.user@example.com"
    },
    "properties": {
      "suppression_state": "none",
      "source": "ui",
      "user": "some_user",
      "registration_type": "unbounce"
    }
  },
  "type": "COMPLIANCE"
}

```

---

## Email unsubscribe event {#unsubscribe}

A compliance event representing a user who unsubscribed from your email notifications.

[Jump to examples ↓](#unsubscribe-examples)

- **`body`** `object` **REQUIRED**

  Contains the event subtype and additional properties about the event.

  **OBJECT PROPERTIES**

  - **`event_type`** `string` **REQUIRED**

    Unsubscribe events are considered `registration` events; the `registration_type` indicates the type of registration occurring.

    Possible values: `registration`

  - **`identifiers`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`address`** `string`

      The email address registered.

  - **`properties`** `object` **REQUIRED**
    **OBJECT PROPERTIES**

    - **`message_type`** `string` **REQUIRED**

      The message type that the user unsubscribed from.

      Possible values: `commercial`

    - **`registration_type`** `string` **REQUIRED**

      Possible values: `unsubscribe`

- **`device`** `object` **REQUIRED**

  Holds information about the email `device` (an individual email channel) the event occurred against.

  **OBJECT PROPERTIES**

  - **`channel`** `string`

    The unique, platform-agnostic channel identifier for a device.

  - **`delivery_address`** `string` **REQUIRED**

    The email address of the channel the event occurred against.

  - **`device_type`** `string` **REQUIRED**

    Email compliance events use the `EMAIL` device type.

    Possible values: `EMAIL`

  - **`named_user`** `string`

    The Named User that the channel is associated with; appears only if the channel is associated with a Named User.


**Used in:**

- [Open a compliance event stream]({{< ref "/developer/rest-api/connect/operations/compliance-event-stream/" >}}#opencomplianceeventstream)
- [Open an event stream]({{< ref "/developer/rest-api/connect/operations/event-stream/" >}}#openeventstream)

**Examples**

*Example email unsubscribe event*

```json
{
  "id": "bd8c90d6-5704-4438-8075-7530d06c4cba",
  "offset": "1000001778792",
  "occurred": "2018-11-27T23:47:54.641Z",
  "processed": "2018-11-27T23:47:55.516Z",
  "device": {
      "channel": "b8519372-54ff-456d-9819-7faa92fe8b9d",
      "device_type": "EMAIL",
      "delivery_address": "former.user@example.com"
  },
  "body": {
      "event_type": "registration",
      "properties": {
          "message_type": "commercial",
          "registration_type": "unsubscribe"
      }
  },
  "type": "COMPLIANCE"
}

```

---