Structure
JSON
{ "name": "<name>", "description": "<description>", "organizationId": "<organization_id>" "hooks": [ { "type": "event_created", "method": "POST", "endpoint": "<hook_endpoint>" }, { "type": "event_removed", "method": "POST", "endpoint": "<hook_endpoint>" }, { "type": "event_updated", "method": "POST", "endpoint": "<hook_endpoint>" }, { "type": "order_created", "method": "POST", "endpoint": "<hook_endpoint>" }, { "type": "order_removed", "method": "POST", "endpoint": "<hook_endpoint>" }, { "type": "order_updated", "method": "POST", "endpoint": "<hook_endpoint>" }, { "type": "order_cancelled", "method": "POST", "endpoint": "<hook_endpoint>" } ], "authentication": { "grant_type": "client_credentials", "endpoint": "<oauth_endpoint>", "credentials": { "client_id": "<client_id>", "client_secret": "<client_secret>" }, "header_format": "Authorization", "header_value_format": "Bearer %ACCESS_TOKEN%" } }
Parameters
- <name>
- <description>
- <organization_id>
- <hook_endpoint>
- <oauth_endpoint>
- <client_id>
- <client_secret>
Example
JSON
{ "name": "My Test Webhook", "description": "Webhook for testing all the hook types", "hooks": [ { "type": "event_created", "method": "POST", "endpoint": "https://requestb.in/123" }, { "type": "event_removed", "method": "POST", "endpoint": "https://requestb.in/123" }, { "type": "event_updated", "method": "POST", "endpoint": "https://requestb.in/123" }, { "type": "order_created", "method": "POST", "endpoint": "https://requestb.in/123" }, { "type": "order_removed", "method": "POST", "endpoint": "https://requestb.in/123" }, { "type": "order_updated", "method": "POST", "endpoint": "https://requestb.in/123" }, { "type": "order_cancelled", "method": "POST", "endpoint": "https://requestb.in/123" } ], "authentication": { "grant_type": "client_credentials", "endpoint": "https://requestb.in/123", "credentials": { "client_id":"doo", "client_secret":"super-strong-pawwsord" }, "header_format": "Authorization", "header_value_format": "Bearer %ACCESS_TOKEN%" } }