cURL
curl --request POST \ --url https://api.xplenty.com/{account_id}/api/hooks \ --header 'Accept: <accept>' \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data ' { "type": "<string>", "name": "<string>", "settings": {}, "events": [ "<string>" ], "active": true } '
{ "id": 123, "type": "<string>", "name": "<string>", "active": true, "settings": {}, "events": [ "<string>" ], "salt": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "url": "<string>" }
Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...
curl -u YOUR_API_KEY: https://api.xplenty.com/...
API version header — required on all requests
Hook-type-specific settings (e.g., URL for web hooks)
Events to subscribe to
Hook created
Was this page helpful?