Webhook Api

Current version: v1.1

List webhooks

Returns a list of your webook endpoints.

GET

/webhook/list.json


$storeden = new Storeden\Storeden($config);
$webhook_list = $storeden->get('/webhook/list.json');


[
    {
        "type": 1,
        "url": "http://my.application.tld/notify.php",
        "name": "OnOrderPaid",
        "id": "57d8240316f46aa43a0d18fe"
    },
	...
]

Get webhook

GET

/webhook/webhook.json?id={id}

PARAMETERS LIST

id required (StoredenId)

Unique id of your webhook


$storeden = new Storeden\Storeden($config);
$webhook_entity = $storeden->get('/webhook/webhook.json?id=5ac.....12');

						
{
    "type": 1,
    "url": "http:\/\/my.application.tld\/notify.php",
    "name": "OnOrderPaid",
    "id": "57d8240316f46aa43a0d18fe"
}

Get Webhook By Name

GET

/webhook/search.json?name={name}

PARAMETERS LIST

name required (string)

Your webhook name


$storeden = new Storeden\Storeden($config);
$webhook_entity = $storeden->get('/webhook/search.json?name=MyCustomWebhook');

						
{
    "type": 1,
    "url": "http:\/\/my.application.tld\/notify.php",
    "name": "OnOrderPaid",
    "id": "57d8240316f46aa43a0d18fe"
}

Add single webhook

POST

/webhook/webhook.json

PARAMETERS LIST

url required (string)	A valid endpoint url
type required (int)	Webhook Type `0` => Triggered on order created `1` => Triggered on order set as paid `2` => Triggered on order set as shipped `3` => Triggered on order set as in preparation `7` => Triggered on order set as cancelled
name required (string)	Your webhook name


$storeden = new Storeden\Storeden($config);

$payload = array();
$payload['url'] = 'https://dummy.domain/webhook/endpoint';
$payload['type'] = 0;
$payload['name'] = 'MyCustomWebhook';

$webhook_operation = $storeden->post('/webhook/webhook.json', $payload);


{
  "ok": 1,
  "err": null,
}

Remove Webhook

DELETE

/webhook/webhook.json

PARAMETERS LIST

id required (StoredenId)

Unique id of your webhook


$storeden = new Storeden\Storeden($config);

$payload = array();
$payload['id'] = '5ac......123';

$webhook_operation = $storeden->delete('/webhook/webhook.json', $payload);


{
  "ok": 1,
  "err": null,
}