Back to Developer Center

API v1 Reference

List Webhooks

Retrieves a list of webhooks.

Endpoint

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

Request

https://api.neoncrm.com/neonws/services/api/webhook/listWebhooks?userSessionId=[session id]&page.pageSize=3&page.currentPage=3

Response

{
    "listWebhooksResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-06-30T19:09:20.636+0000",
        "webhooks": {
            "webhook": [
                {
                    "id": 23,
                    "webhookName": "Donation New",
                    "eventTrigger": "CREATE_DONATION",
                    "contentType": "FORM"
                },
                {
                    "id": 24,
                    "webhookName": "CreateAccount",
                    "eventTrigger": "CREATE_ACCOUNT",
                    "contentType": "JSON"
                },
                {
                    "id": 25,
                    "webhookName": "UpdateDonation",
                    "eventTrigger": "UPDATE_DONATION",
                    "contentType": "JSON"
                }
            ]
        },
        "page": {
            "currentPage": 1,
            "pageSize": 3,
            "totalPage": 2,
            "totalResults": 4
        }
    }
}

Request Parameters

Parameter Required Description
page.pageSize The number of results per page. Default is 20.
page.currentPage The desired page of results to retrieve. Default is 1.

Response Parameters

Parameter Description
webhooks.webhook.id
webhooks.webhook.webhookName
webhooks.webhook.eventTrigger The action taken in NeonCRM that triggers this webhook.
webhooks.webhook.contentType Possible values: JSON, FORM.
page.currentPage
page.pageSize
page.totalPage
page.totalResults