API DOCUMENTATION
Webhooks methods
POST
webhook/create
This method create a new webhook.
Request url
https://api.salespoints.co/webhook/create
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data:
{
"method":"post",
"url":"http://example.com",
"actionId":"2",
"description":"example"
}
Parameter Description
method Required Method what action should do, for example - post, get, put, delete
url Required Link where to perform hook
actionId Required When to perform hook @see actions()
description Optional Description of the hook
POST
webhook/delete
This method delete an existing webhook.
Request url
https://api.salespoints.co/webhook/delete
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"slug":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}
Parameter Description
slug Required Identificator
POST
webhook/update
This method update an existing webhook by slug.
Request url
https://api.salespoints.co/webhook/update
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data:
{
"slug":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
"method":"post",
"url":"http://example.com",
"actionId":"2",
"description":"example"
}
Parameter Description
slug Required Identificator
method Optional Method what action should do, for example - post, get, put, delete
url Optional Link where to perform hook
actionId Optional When to perform hook @see actions()
description Optional Description of the hook
POST
webhook/get
This method get single layout by slug.
Request url
https://api.salespoints.co/webhook/get
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"slug":"xxxxxxxxxxxxxxxxxxxxxxxxxx"}
Parameter Description
slug Required Identificator
POST
webhook/list
This method returns list of all available templates.
Request url
https://api.salespoints.co/webhook/list
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx
POST
webhook/actions
This method returns list of all available actions.
Request url
https://api.salespoints.co/webhook/actions
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

 
Webhook JSON data example
This example of two OPEN events in one POST
[{
"event": "open",
"ts": 1512571674,

"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36",

"ip": "192.168.0.0",
"_id": "173473239",
"url": "null",
"msg": {
"ts": null,
"_id": "173473239",
"state": null,
"subject": null,
"email": "[email protected]",
"tags": [],
"clicks": [{
"ts": null,
"ip": null,
"location": "null",
"ua": null
}],
"resends": [],
"_version": null,
"metadata": [
"accountId": "370385200400907879",
"campaignId": "5799",
"brandId": "3",
"campaignInstanceId": "5266"
],
"sender": null,
"template": null
}
},{
"event": "open",
"ts": 1512571677,

"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36",

"ip": "159.2.0.11",
"_id": "173471536",
"url": "null",
"msg": {
"ts": null,
"_id": "173471536",
"state": null,
"subject": null,
"email": "[email protected]",
"tags": [],
"clicks": [{
"ts": null,
"ip": null,
"location": "null",
"ua": null
}],
"resends": [],
"_version": null,
"metadata": [
"accountId": "370265200400907060",
"campaignId": "5799",
"brandId": "3",
"campaignInstanceId": "5266"
],
"sender": null,
"template": null
}
}]