Webhooks

The Wallets API allows you to create and retrieve information on all webhooks on your account.

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 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.

Get User Carriers

Create Webhook

Last modified 6mo ago

Attribute	Type	Description
active	boolean	Indicates if webhook is actve.
events	array	List of of webhook event 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.