Summary:
Modify a specify custom webhook endpoint.
URL:
http(s)://{server hostname}/api/webhooks/endpoints/{endpoint ID}
Methods summary
PUT Method - modify the specified custom webhook endpoint
PUT Method detail
Modifies the specified custom webhook endpoint.
Response:
| Name | Description |
|---|---|
| endpointID | ID of the endpoint. |
| objectID | ID of the object on which the endpoint URL is found. |
| serverID | ID of the server on which the endpoint object is found. |
| payloadMax | maximum number of payloads that Entuity will store at any one time. For example, if you specify a payload maximum of 3, then the 3 most recent payloads will be stored. When a new payload is received, the oldest of the 3 saved would then be deleted and replaced with the new one. Note, the payload maximum cannot be edited if payload collection is disabled. |
| saveEnabled | whether payload collection is enabled, either true or false. If false, this will prevent the saving of any further payloads. |
Example:
INPUT
curl -k -u admin:admin https://localhost/api/webhooks/endpoints/5 -H "content-type:application/json" -X PUT
'{
"endpointID" : 5,
"objectID" : 854,
"serverID" : "49cb73f5-4aa5-4dbf-9219-9f86a5e8fe8e",
"payloadMax" : 2,
"saveEnabled" : true
}'
OUTPUT
{
"successCount" : 1,
"failureCount" : 0,
"errorCode" : 0,
"message" : "Succeeded to edit Webhook endpoint '5'.",
"otherResults" : [ ]
}
Comments
0 comments
Please sign in to leave a comment.