Back to Developer Center

API v1 Reference

Webhooks

NeonCRM supports webhook POST notifications for actions within the system. These webhooks can be managed from the system user interface or through the Webhooks API.

Types of Webhooks

NeonCRM provides webhook notifications for the CREATE, UPDATE, and DELETE actions for the following data types. Further specifications about the data sent can be found by following the links below:

Creating Webhooks

  1. Navigate to System Settings > Home/Dashboard > Developer Tools > Webhooks.
  2. Click New Webhook.
  3. Provide the necessary details and click Add Webhook.

Webhook Field Descriptions

Webhook Name
The internal name for this webhook.
URL to Notify
The URL to which the webhook POST will be sent.
Event Trigger
The event in NeonCRM that triggers the sending of the webhook POST.
Content Type
The format used for the POST data. Possible values: application/x-www-form-urlencoded, application/json. If you specify application/x-www-form-urlencoded, the data will be sent as a JSON string in a form parameter called “payload”.
Authentication: Username
If your webhook uses HTTP basic authentication, the provided user name displays here.
Authentication: Password
If your webhook uses HTTP basic authentication, the provided password displays here.
Custom Parameters
Custom parameters are name/value pairs that are sent with every POST. These can be used for sending credentials such as API keys or other data useful for your application.

Webhook Data Format

Webhooks follow a standard format. The following parameters are included with all webhook notifications:

{ 
   "eventTrigger":"createAccount",
   "eventTimestamp":"2017-01-24T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{
      ...
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}
eventTrigger
The event in NeonCRM that triggers the sending of the webhook POST.
eventTimeStamp
The date/time that the event was triggered.
organizationId
The NeonCRM organization ID of the system that triggered the webhook.
data
The data returned by this parameter is variable depending on the webhook triggered. It contains the constituent or transaction data relevant to the triggered action.
customParameters
Custom parameters are name/value pairs that are sent with every POST. These can be used for sending credentials such as API keys or other data useful for your application.