Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 9 Next »

Structure

JSON
{
  "name": "<name>",
  "description": "<description>",
  "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%"
  }
}

NOTE: in case you don't have OAuth endpoint and want to omit the authorization step with your server - don't include authentication property into the AddWebhook object

Parameters

ParameterRequiredDescription
<name>YesWebhook name
<description>NoWebhook detailed description

<hook_endpoint>

Yes

Your server URL where you want to receive the webhook request

Can be separate for each hook type

<oauth_endpoint>

Yes

Your server OAuth endpoint URL

<client_id>

NoClient Id for your OAuth endpoint 

<client_secret>

NoClient Secret for your OAuth endpoint 

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-secret"
    },
    "header_format": "Authorization",
    "header_value_format": "Bearer %ACCESS_TOKEN%"
  }
}
  • No labels