Retrieve Webhook

Retrieves a specific webhook’s details.

Endpoint

https://api.neoncrm.com/neonws/services/api/webhook/retrieveWebhook

Request

https://api.neoncrm.com/neonws/services/api/webhook/retrieveWebhook?userSessionId=[session id]&id=17

Response

{
    "retrieveWebhookResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-06-30T19:56:28.355+0000",
        "webhook": {
            "id": 17,
            "webhookName": "New Donation Alert",
            "notifyUrl": "https://myapp.app/webhooks",
            "eventTrigger": "CREATE_DONATION",
            "contentType": "application/x-www-form-urlencoded",
            "userName": ""
        }
    }
}

Request Parameters

Parameter Required Description
id Yes The ID of the webhook to be retrieved.

Response Parameters

Parameter Description
webhook.id The ID of the webhook.
webhook.webhookName The internal name for this webhook.
webhook.notifyUrl The URL to which the webhook POST will be sent.
webhook.eventTrigger The event in NeonCRM that triggers the sending of the webhook POST. Possible values: CREATE_ACCOUNT, UPDATE_ACCOUNT, DELETE_ACCOUNT, CREATE_DONATION, UPDATE_DONATION, DELETE_DONATION, CREATE_MEMBERSHIP, UPDATE_MEMBERSHIP, DELETE_MEMBERSHIP, CREATE_ACTIVITY, UPDATE_ACTIVITY, DELETE_ACTIVITY.
webhook.contentType Possible values: application/x-www-form-urlencoded, application/json. If application/x-www-form-urlencoded, the data will be sent as a JSON string in a form parameter called “payload”.
webhook.userName If your webhook uses HTTP basic authentication, the provided user name displays here. Passwords cannot be retrieved.
webhook.parameters Webhook custom parameters cannot be retrieved through the API.

Error Codes

Code Text Description
17007 WEBHOOK_ID_IS_REQUIRED Webhook id is required.
17008 WEBHOOK_ID_IS_INVALID Webhook id is invalid.