Webhooks
Update Webhook
This endpoint allows you to update a specific Webhook's information. If the specified Webhook does not exist, the response will be a "bad request".
You will only be able to update an Webhooks after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
This endpoint allows you to update the information of a specific Webhook. In order to update a Webhook, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| Attribute | Type | Description |
|---|---|---|
| action | String | The values can be: insert, update or delete |
| entity | String | The values can be: account, contact, opportunity, activity, calendar, salesorder |
| name | String | The name of the WebHook |
| url | String | The website of the WebHook. Should be an "http" request |
| version | String | The Webhook version |
RESPONSE
Returns a JSON with information about the Webhook just updated.
| Attribute | Type | Description |
|---|---|---|
| Message | String | Shows the operation status |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
put/hooks/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/hooks/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Webhook
Changes
No recorded changes to this operation across all 1 revision of this API.