Field | Type | Required | Description | Example |
---|---|---|---|---|
event |
str | ✔️ | Type of event that triggers the webhook. | track_updated |
url |
str | ✔️ | URL webhook events are sent to. | https://example.com/shippo-webhook |
active |
Optional[bool] | ➖ | Determines whether the webhook is active or not. | true |
is_test |
Optional[bool] | ➖ | Determines whether the webhook is a test webhook or not. | false |
object_created |
date | ➖ | Timestamp of the creation of the webhook. | |
object_id |
Optional[str] | ➖ | Unique identifier of the webhook. This can be used to retrieve or delete the webhook. | |
object_updated |
date | ➖ | Timestamp of the last update of the webhook. | |
object_owner |
Optional[str] | ➖ | Username of the user who created the webhook. |