# Webhooks

### The Webhook Object

This section describes the different attributes available for a webhook.

| Attribute   | Type       | Description                                                                                                                                                                                                                                             |
| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active      | *boolean*  | Indicates if webhook is actve.                                                                                                                                                                                                                          |
| events      | *array*    | List of of [webhook event](https://docs.terminal.africa/tship/miscallaneous/webhook-events) types e.g. ***address.created***, ***address.updated***, **shipment.created**, ***shipment.updated***, ***transaction.success***, ***transaction.failed***. |
| id          | *string*   | Unique identifier for webhook.                                                                                                                                                                                                                          |
| live        | *string*   | Indicates if webhook is for live environment.                                                                                                                                                                                                           |
| name        | *string*   | Webhook name.                                                                                                                                                                                                                                           |
| url         | *string*   | Endpoint url for receiving webhook events.                                                                                                                                                                                                              |
| user        | *string*   | Unique identifier for user.                                                                                                                                                                                                                             |
| webhook\_id | *string*   | Unique reference for webhook.                                                                                                                                                                                                                           |
| created\_at | *datetime* | Time webhook created.                                                                                                                                                                                                                                   |
| updated\_at | *datetime* | Time webhook last updated.                                                                                                                                                                                                                              |