---
updatedAt: 2025-11-11T23:07:01.000Z
agentTools:
  projectIndex: https://developers.shipup.co/llms.txt
---

# Notification payload

## Example payload

```json
{
    "object": "notification_payload",
    "id": 91,
    "created_at": "2024-07-17T15:40:01Z",
    "dispatched": false,
    "status": "error",
    "error": "no_template",
    "type": "email",
    "support_cced": null
}
```

## Attributes

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        FIELD
      </th>

      <th>
        DESCRIPTION
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **dispatched**
        boolean
      </td>

      <td>
        Whether or not the notification\_payload has been dispatched
      </td>
    </tr>

    <tr>
      <td>
        **status**\
        string
      </td>

      <td>
        One of 'built', 'dispatched', 'error' or 'cancel'
      </td>
    </tr>

    <tr>
      <td>
        **error**\
        string
      </td>

      <td>
        In case an error has occurred for this notification\_payload, details about the error.
      </td>
    </tr>

    <tr>
      <td>
        **type**\
        string
      </td>

      <td>
        Corresponds to the channel through which the notification\_payload has been sent (sms, email, etc.)
      </td>
    </tr>

    <tr>
      <td>
        **created\_at**\
        datetime
      </td>

      <td>
        Time at which the notification was created
      </td>
    </tr>
  </tbody>
</Table>