Skip to main content

Understanding Webhook Events in Your Account

Updated

plan_availability_all_plans.png

Overview

Webhooks allow you to receive real-time updates on various actions within your account. If webhooks are enabled in your account settings, your system can listen for these events and take automated actions based on the data received.

Below is a complete list of webhook events that your account can listen to when specific actions occur.

Webhook Event Categories

Webhooks are grouped into the following categories based on their functionality:

  1. Delivery Address Events
  2. Asset Events
  3. Team Member Events
  4. Office Branch Events
  5. Retrieval Events
  6. Warehouse Shipment Events

1. Delivery Address Events

These events trigger when a delivery address is added, updated, or removed.

Event Name Description
delivery.address.created A new delivery address has been added to the system.
delivery.address.updated An existing delivery address has been updated.
delivery.address.deleted A delivery address has been removed from the system.

2. Asset Events

These events track changes to assets, including creation, updates, assignments, and warehouse movements.

Event Name Description
asset.created A new asset has been created.
asset.updated An existing asset has been updated.
asset.deleted An asset has been deleted from the system.
asset.assignment.created An asset has been assigned to a user or location.
asset.assignment.updated An asset's assignment details have been updated.
asset.note.created A note has been added to an asset.
asset.note.deleted A note has been removed from an asset.
asset.document.uploaded A document related to an asset has been uploaded.
asset.document.removed A document related to an asset has been removed.
asset.warehouse.assigned An asset has been assigned to our warehouse (IT Closet).
asset.warehouse.updated The warehouse details for an asset have been updated.
asset.warehouse.dispatched An asset has been dispatched from our warehouse.

3. Team Member Events

These events notify you when actions related to team members occur.

Event Name Description
team-member.created A new team member has been added to the system.
team-member.updated A team member’s details have been updated.
team-member.document.uploaded A document related to a team member has been uploaded.
team-member.document.removed A document related to a team member has been removed.

4. Office Branch Events

These events track changes to office branches within your system.

Event Name Description
office-branch.created A new office branch has been added.
office-branch.updated An existing office branch has been updated.
office-branch.deleted An office branch has been removed from the system.

5. Retrieval Events

These events provide updates on retrieval kits™ and related notes.

Event Name Description
retrieval.created A new retrieval request has been created.
retrieval.updated An existing retrieval request has been updated.
retrieval.note.created A note has been added to a retrieval request.
retrieval.note.deleted A note has been removed from a retrieval request.

6. Warehouse Shipment Events

These events notify you about warehouse shipments when they are created or updated.

Event Name Description
warehouse.shipment.created A new warehouse shipment has been created.
warehouse.shipment.updated An existing warehouse shipment has been updated. Includes tracking numbers, carrier information, shipping status.

How to Enable Webhooks

To start receiving webhook events, ensure you have enabled webhooks in your account settings:

  1. Navigate to Account > Webhooks & API.
  2. Add your Webhook URL where events should be sent.
  3. Select the mode you want to subscribe to (production or test).
  4. Click Save to start receiving real-time notifications.

Webhook Payload Example

Here’s an example of a webhook payload when an asset.assignment.created event occurs: json

 
{
  "event": "asset.assignment.created",
  "data": {
    "id": "9e54acd4-5592-4fad-881a-8a1bc9598b06",
    "asset": {
      "id": "24dc4301-dfd6-4cfb-861b-78c3cf356b62",
      "name": "Apple 2020 MacBook Pro With M1 Chip (13-inch, 8GB RAM, 256GB SSD Storage) - Space Gray"
    },
    "assignable": {
      "id": "9e54abf3-017a-4505-ad90-6854544c5e4e",
      "type": "team_member"
    },
    "assigned_date": "2025-02-25T00:00:00.000000Z",
    "returned_date": null,
    "created_at": "2025-03-01T21:39:00.000000Z",
    "updated_at": "2025-03-01T21:39:00.000000Z"
  },
  "eventDetail": {
    "eventType": "asset.assignment.created",
    "eventMode": "production",
    "eventId": "evt_S0Kq8R4KPveXii3sTo1BoT8au1enos"
  }
}

Conclusion

Webhooks provide real-time updates on important changes within your account. By subscribing to these events, you can automate workflows, sync data with external systems, and enhance your overall operations.

If you have any questions or need assistance with webhooks, feel free to contact support. 🚀

Related to

Related articles