For more information on using API
GET http://webapi.mymarketing.co.il/api/webhooks?EventType={EventType}&StateType={StateType}&TargetType={TargetType}&IsIgnoreParameters={IsIgnoreParameters}
Get all the Webhooks info in your account
Request Information
URI Parameters
Name
Description
Type
Additional information
is_ignore_parameters
boolean
Body Parameters
None.
Response Information
Resource Description
Name
Description
Type
Additional information
id
Event id
integer
name
The name of the web-hook
string
Required
url
The customer url you want the web-hook to call and send parameters to
string
stateid
The state (status) id. details in the TypesStateTypes enum Deprecated - please use the is_active flag
parameters
The event parameters to send to the url. detaits in the ParametersDetailsItem enum
Collection of ParametersDetailsItem
is_active
Is this web-hook active or not
boolean
date_updated_utc
date
date_created_utc
date
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"name": "sample string 2",
"url": "sample string 3",
"event_type": "contact_change",
"stateid": 5,
"parameters": [
{
"id": 1,
"key": "sample string 2",
"value": "sample string 3",
"event_parameter_type": "header"
},
{
"id": 1,
"key": "sample string 2",
"value": "sample string 3",
"event_parameter_type": "header"
}
],
"is_active": true,
"target_type_id": "zapier",
"date_updated_utc": "2016-12-24T14:12:12",
"date_created_utc": "2016-12-24T14:12:12"
},
{
"id": 1,
"name": "sample string 2",
"url": "sample string 3",
"event_type": "contact_change",
"stateid": 5,
"parameters": [
{
"id": 1,
"key": "sample string 2",
"value": "sample string 3",
"event_parameter_type": "header"
},
{
"id": 1,
"key": "sample string 2",
"value": "sample string 3",
"event_parameter_type": "header"
}
],
"is_active": true,
"target_type_id": "zapier",
"date_updated_utc": "2016-12-24T14:12:12",
"date_created_utc": "2016-12-24T14:12:12"
}
]
application/xml, text/xml
Sample:
<ArrayOfUserApiEventItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
<UserApiEventItem>
<date_created_utc>2016-12-24T14:12:12</date_created_utc>
<date_updated_utc>2016-12-24T14:12:12</date_updated_utc>
<event_type>contact_change</event_type>
<id>1</id>
<is_active>true</is_active>
<name>sample string 2</name>
<parameters>
<ParametersDetailsItem>
<event_parameter_type>header</event_parameter_type>
<id>1</id>
<key>sample string 2</key>
<value>sample string 3</value>
</ParametersDetailsItem>
<ParametersDetailsItem>
<event_parameter_type>header</event_parameter_type>
<id>1</id>
<key>sample string 2</key>
<value>sample string 3</value>
</ParametersDetailsItem>
</parameters>
<stateid>Untitled</stateid>
<target_type_id>zapier</target_type_id>
<url>sample string 3</url>
</UserApiEventItem>
<UserApiEventItem>
<date_created_utc>2016-12-24T14:12:12</date_created_utc>
<date_updated_utc>2016-12-24T14:12:12</date_updated_utc>
<event_type>contact_change</event_type>
<id>1</id>
<is_active>true</is_active>
<name>sample string 2</name>
<parameters>
<ParametersDetailsItem>
<event_parameter_type>header</event_parameter_type>
<id>1</id>
<key>sample string 2</key>
<value>sample string 3</value>
</ParametersDetailsItem>
<ParametersDetailsItem>
<event_parameter_type>header</event_parameter_type>
<id>1</id>
<key>sample string 2</key>
<value>sample string 3</value>
</ParametersDetailsItem>
</parameters>
<stateid>Untitled</stateid>
<target_type_id>zapier</target_type_id>
<url>sample string 3</url>
</UserApiEventItem>
</ArrayOfUserApiEventItem>