Updates an existing webhook subscription.
Endpoint
https://api.neoncrm.com/neonws/services/api/webhook/updateWebhook
Request
https://api.neoncrm.com/neonws/services/api/webhook/updateWebhook?webhook.id=27&webhook.webhookName=My%20Test%20Webhook&userSessionId=[session id]
Response
{
"updateWebhookResponse": {
"operationResult": "SUCCESS",
"responseDateTime": "2017-06-30T19:42:18.494+0000",
"id": 27
}
}
Request Parameters
Parameter |
Required |
Description |
webhook.id |
Yes |
The ID of the webhook to be updated. |
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, provide a user name here. |
webhook.password |
|
If your webhook uses HTTP basic authentication, provide a password here. |
webhook.parameters.nameValuePair.name |
|
Provide the name for a custom parameter to be included with all webhook POSTs. This field is repeatable. |
webhook.parameters.nameValuePair.value |
|
Provide the value for a custom parameter to be included with all webhook POSTs. This field is repeatable. |
Response Parameters
Parameter |
Description |
id |
The ID of the webhook that was updated. |
Error Codes
Code |
Text |
Description |
17007 |
WEBHOOK_ID_IS_REQUIRED |
Webhook id is required. |
17008 |
WEBHOOK_ID_IS_INVALID |
Webhook id is invalid. |
17005 |
NOTIFY_URL_IS_INVALID |
Notify URL is invalid. |
17006 |
CONTENT_TYPE_IS_INVALID |
Content type is invalid. |