Create a new Webhook

POST {{baseUrl}}/webhooks

Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - event_action and event_object. E.g., use *.* for getting notifications about all events, added.deal for any newly added deals, deleted.persons for any deleted persons, etc. See the guide for Webhooks for more details.

Request Body

{"subscription_url"=>"<string>", "event_action"=>"<string>", "event_object"=>"<string>", "user_id"=>"<integer>", "http_auth_user"=>"<string>", "http_auth_password"=>"<string>", "version"=>"1.0"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;status&quot;:&quot;ok&quot;,&quot;success&quot;:true,&quot;data&quot;:{&quot;id&quot;:1,&quot;company_id&quot;:1,&quot;owner_id&quot;:1,&quot;user_id&quot;:1,&quot;event_action&quot;:&quot;added&quot;,&quot;event_object&quot;:&quot;activityType&quot;,&quot;subscription_url&quot;:&quot;http://example.org&quot;,&quot;version&quot;:&quot;1.0&quot;,&quot;is_active&quot;:1,&quot;add_time&quot;:&quot;2019-10-25T08:25:27.000Z&quot;,&quot;remove_time&quot;:null,&quot;type&quot;:&quot;general&quot;,&quot;http_auth_user&quot;:null,&quot;http_auth_password&quot;:null,&quot;additional_data&quot;:{},&quot;remove_reason&quot;:null,&quot;last_delivery_time&quot;:null,&quot;last_http_status&quot;:null,&quot;admin_id&quot;:1}}