API credentials and webhooks
Your ShopWired account's API credentials
You can create API credentials (an API key and an API secret) that can be used by external applications to read and write data to and from your ShopWired account.
To create API credentials for your ShopWired account:
- Navigate to Your account (top right) > API & webhooks
- Select
create API key - Enter a Name for the API key
- Select the Permissions for the API key (these determine which API services the key has access to)
- Select
create API key
The API key will then be displayed in the table and you can view the API secret by selecting the View option.
You can use the edit option to edit the permissions for an API key/secret or the delete option to remove it from your account.
ShopWired webhooks
ShopWired webhooks
Webhooks are used by ShopWired to send notifications when certain events happen on your ShopWired account (for example, when a new order is created or when a product is edited). ShopWired will send a POST request to a subscribed URL.
A list of available webhooks can be viewed by navigating to Your account (top right) > API & webhooks and using the add new webhook option to view the available webhooks in the Select the webhook topic list.
To request a new webhook notification:
- Navigate to Your account (top right) > API & webhooks
- Select the
add new webhookoption - Use the Select the webhook topic setting to select the webhook you would like to be notified for
- Enter the URL that you would like to receive the notification to using the Enter the notification URL for the webhook setting (HTTPS is required for all URLs)
- A verification will be sent to the webhook's notification URL which should be responded to with the verification request payload
