post https://api.lime-go.com/v:version/event/subscription
Creates a subscription for the specified events. Lime Go will invoke your web hook when the event occurs.
The subscription request must include targeturl. The URL must be an absolute URL and should point to your web hook.
The list of events is a string array that contains the events that you are interested in. If this is an empty list all events will be sent to your web hook. The available events are:
Event | Description |
---|---|
OrganizationBeenInTouch | Invoke the web hook when an organization's relation changed to "Been In Touch". |
OrganizationHasNoRelation | Invoke the web hook when an organization's relation changed to "No Relation". |
OrganizationIsACustomer | Invoke the web hook when an organization's relation changed to "Is A Customer". |
OrganizationWasACustomer | Invoke the web hook when an organization's relation changed to "Was A Customer". |
OrganizationWorkingOnIt | Invoke the web hook when an organization's relation changed to "Working On It". |
DealWon | Invoke the web hook when a deal is won. |
DealLost | Invoke the web hook when a deal is lost. |
DealStatusChange | Invoke the web hook when a deal's status change. |
CallPositive | Invoke the web hook when a call with a positive outcome is made on a calling list. |
CallNegative | Invoke the web hook when a call with a negative outcome is made on a calling list. |
MeetingBooked | Invoke the web hook when a meeting is booked. Only the main participants in the meeting is returned, not the additional participants. |
MeetingReported | Invoke the web hook when a meeting is reported. Only the main participants in the meeting is returned, not the additional participants. |
MeetingCancelled | Invoke the web hook when a meeting is cancelled. Only the main participants in the meeting is returned, not the additional participants. |
If the request is successful the id of the new subscription will be returned. This id should be used if you want to unsubscribe.
Returns 400 (Bad Request) if the targeturl is invalid.