Notifications

The ARTA API provides notifications for various milestones in the shipment lifecycle. Webhook and email notifications can be configured to meet your integration and communication needs.

Emails

You can configure email rules and subscribers for ARTA branded shipment lifecycle emails.

Email rules and subscriptions exist in either Live or Test modes; they are managed with either Live or Test keys to enable more control when building/testing/operating your integration.

API Reference

Email Subscriptions endpoints
Email Rules endpoints

We currently provide three update types via email.

  • Booking: Your shipment has been confirmed.
  • Scheduling: There’s an update to your delivery schedule.
  • Complete: Your shipment has been delivered.

Email Subscriptions enable you to subscribe members of your team or a distribution list to ARTA email notifications by providing an email address per email type.

Email Rules enable you to configure rules to send ARTA email notifications to contacts on a particular shipment such as the Origin or Delivery contacts.

Webhooks

You can configure webhook endpoints for your organization so that ARTA can programatically notify you as shipments are created and updated.

Webhook endpoints may be separately configured with Live or Test keys to support your building and testing custom notification systems.

API Reference

Webhook endpoints

Every shipment webhook payload is comprised of three main parts:

  • data — a representation of the shipment equivalent to the retrieve shipment API endpoint
  • object — the name of the resource type; at present the value will always be shipment
  • type — a label describing the type of webhook being sent

Currently, ARTA will send shipment webhook notifications with the following types:

  • shipment.created — Sent when the shipment is created
  • shipment.status.updated — Sent when the shipment's status has transitioned from one state to another
  • shipment.schedule.updated — Sent when a change has been made to the shipment's collection and/or delivery schedule
  • shipment.tracking.updated — Sent when the tracking details are updated for a shipment

The following is a sample webhook message payload:

{
  "data": {
    "created_at": "2021-02-10T18:12:37.795261",
    "destination": {
      "access_restrictions": [],
      "address_line_1": "87 Richardson St",
      "address_line_2": null,
      "address_line_3": null,
      "city": "New York",
      "contacts": [
        {
          "email_address": "al@example.com",
          "name": "Alfred Barr",
          "phone_number": "(222) 222-2222"
        }
      ],
      "country": "US",
      "postal_code": "11249",
      "region": "NY",
      "title": "Home"
    },
    "id": "c7660839-4fa5-4c39-a2f8-78348f1f7643",
    "insurance_policy": null,
    "internal_reference": null,
    "object_count": 1,
    "origin": {
      "access_restrictions": [],
      "address_line_1": "11 W 53rd St",
      "address_line_2": null,
      "address_line_3": null,
      "city": "New York",
      "contacts": [
        {
          "email_address": "mary@example.com",
          "name": "Mary Quinn Sullivan",
          "phone_number": "(333) 333-3333"
        }
      ],
      "country": "US",
      "postal_code": "10019",
      "region": "NY",
      "title": "Warehouse"
    },
    "package_count": 1,
    "packages": [
      {
        "depth": "6.0",
        "handle_with_care": false,
        "height": "14.5",
        "id": 1536,
        "is_sufficiently_packed": false,
        "objects": [
          {
            "current_packing": [],
            "depth": "2",
            "details": {
              "creation_date": null,
              "creator": "Robert Irwin",
              "is_cites": false,
              "is_fragile": false,
              "materials": [],
              "notes": null,
              "title": "All That Jazz"
            },
            "height": "10.5",
            "images": [],
            "internal_reference": null,
            "public_reference": null,
            "subtype": "painting_unframed",
            "type": "art",
            "unit_of_measurement": "in",
            "value": "15000",
            "value_currency": "USD",
            "weight": "3.5",
            "weight_unit": "lb",
            "width": "10"
          }
        ],
        "packing_materials": ["strongbox"],
        "unit_of_measurement": "in",
        "weight": "3.5",
        "weight_unit": "lb",
        "width": "14.0"
      }
    ],
    "public_reference": "SC-799212: New York, NY, US to New York, NY, US",
    "quote_type": "select",
    "schedule": {
      "delivery_end": null,
      "delivery_start": null,
      "pickup_end": null,
      "pickup_start": null
    },
    "services": [
      {
        "amount": "1.00",
        "amount_currency": "USD",
        "included_services": [],
        "is_requested": false,
        "is_required": true,
        "name": "Consolidated Trucking",
        "sub_subtype": "road_groupage",
        "subtype": "consolidated",
        "type": "transport"
      },
      {
        "amount": "1.00",
        "amount_currency": "USD",
        "included_services": [],
        "is_requested": false,
        "is_required": true,
        "name": "Strongbox",
        "sub_subtype": "strongbox",
        "subtype": "packing_materials",
        "type": "packing"
      },
      {
        "amount": "1.00",
        "amount_currency": "USD",
        "included_services": [],
        "is_requested": false,
        "is_required": true,
        "name": "Fuel Surcharge",
        "sub_subtype": "fuel_surcharge",
        "subtype": "fees",
        "type": "taxes_duties_fees"
      },
      {
        "amount": "1.00",
        "amount_currency": "USD",
        "included_services": [],
        "is_requested": false,
        "is_required": true,
        "name": "Debris Disposal",
        "sub_subtype": "debris_disposal",
        "subtype": "debris_disposal",
        "type": "handling"
      }
    ],
    "shipping_notes": null,
    "shortcode": "SC-799212",
    "status": "pending",
    "total": "4.00",
    "total_currency": "USD",
    "tracking": [],
    "updated_at": "2021-02-10T18:12:37.882318",
    "url": "https://connect.shiparta.com/shipments/c7660839-4fa5-4c39-a2f8-78348f1f7643/rHr9fi87GAmziLjwoXFRrQl3"
  },
  "object": "shipment",
  "type": "shipment.created"
}