---
updatedAt: 2026-07-08T12:54:54.000Z
agentTools:
  projectIndex: https://developers.shipup.co/llms.txt
---

# Event

## Example payload

```json
{
  "object": "event",
  "id": 775,
  "event_type_code": "label_created",
  "happened_at": "2024-07-17T00:00:00Z",
  "message": null,
  "raw": null,
  "messages": {
    "en": "Label Created, tracking details will be available once the package arrives at the LaserShip facility",
    "fr": "Etiquette colis crée, les informations de suivi seront disponible lorsque le colis arrivera au centre Lasership"
  },
  "standard_event": {
    "name": "",
    "slug": "in_transit"
  },
  "address": null
}
```

## Attributes

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

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

  <tbody>
    <tr>
      <td>
        **event\_type\_code**
        string
      </td>

      <td>
        See [Event type codes](https://developers.shipup.co/reference/event-type-codes)
      </td>
    </tr>

    <tr>
      <td>
        **happened\_at**<br />datetime
      </td>

      <td>
        Datetime at which the event occurred. Can be null if the carrier has not shared with us a value.
      </td>
    </tr>

    <tr>
      <td>
        **message**<br />string
      </td>

      <td>
        Event message.<br />Shipup cannot guarantee that this message will stay unchanged for the same event type. Shipping carriers or Shipup might edit them at any time so don't use them as a lookup key
      </td>
    </tr>

    <tr>
      <td>
        **raw**<br />string (JSON or HTML)
      </td>

      <td>
        Raw information of the carrier. Depending on the carrier, format can be HTML or JSON, both expressed as a string
      </td>
    </tr>

    <tr>
      <td>
        **messages**<br />object
      </td>

      <td>
        Object whose keys are language codes. Corresponds to the messages for this event depending on the language (for instance, of the tracking page)
      </td>
    </tr>

    <tr>
      <td>
        **standard\_event**<br />object
      </td>

      <td>
        This object will only appear when the carrier event is associated with a standard event (predefines the notification that will be sent to the client, as well as the text exhibited in the tracking page).&#x20;
      </td>
    </tr>

    <tr>
      <td>
        **slug**<br />string
      </td>

      <td>
        Internal key for the type of event it represents (more specific than **event\_type\_code**), see [Event type codes](https://developers.shipup.co/reference/standard-slug-codes)
      </td>
    </tr>

    <tr>
      <td>
        **name**<br />string
      </td>

      <td>
        A readable name for the standard event associated with the event.
      </td>
    </tr>

    <tr>
      <td>
        **address**<br />object, optional
      </td>

      <td>
        Address at which the event took place if known, see [Address](https://developers.shipup.co/reference/address-api-resource)
      </td>
    </tr>
  </tbody>
</Table>

<br />