Webhooks

Neon CRM supports webhook POST notifications for various actions within a Neon CRM system. These webhooks can be managed either from the user interface or through the Webhooks API.

Webhooks exist for createupdate, and delete actions for the following Neon CRM data types:

  • Accounts
  • Donations
  • Memberships
  • Event Registrations
  • Orders
  • Activities

Set up a webhook

Webhooks can be set up in the Neon CRM UI or via the API.

Setting up webhooks in Neon CRM

  1. Navigate to Settings (cog) > Global Settings > Webhooks
  2. Click New Webhook
  3. Provide the required details to set up your webhook
webhooks-3
  • 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 named “payload”.
  • Authentication:
    • Username – If your webhook uses HTTP basic authentication, the provided user name displays here.
    • 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.

Setting up webhooks in the API

Webhooks can also be set up using the Webhooks API available for both API v1 and v2. See the API reference links in the section below for more information.

Webhook Data Format

Webhooks send data in a standard JSON format.

{ 
  "eventTrigger": "createAccount",
  "eventTimestamp": "2021-04-06T09:11:59.000-06:00",
  "organizationId": "myorg",
  "data": {
    ...
  },
  "customParameters":{ 
    "customParameterA":" value",
    "customParameterB": "other value"
  }
}
  • eventTrigger – The event in Neon CRM that triggers the sending of the webhook POST.
  • eventTimeStamp – The date-time that the event was triggered.
  • organizationId – The Neon CRM organization ID of the system that triggered the webhook.
  • data – The data returned by this parameter. This object 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.

API Reference

API methods related to webhooks.