Webhooks
List Webhooks
Returns all Webhooks available in the user's ForceManager implementation database.
You will only receive the list of 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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
This endpoint returns information about all Webhooks available.
List of the supported Webhooks 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 |
| dateCreated | String | Date and time when the Webhook was created |
| dateDeleted | String | Date and time when the Webhook was deleted |
| dateUpdated | String | Date and time when the Webhook was last updated |
| deleted | Boolean | If true, the Webhook has been deleted and archived |
| id | Integer | Unique identifier for the Webhook in ForceManager |
| name | String | The name of the Webhook |
| url | String | The endpoint of the Webhook |
| user_deleted | Integer | Unique identifier of the user who created the Webhook |
| user_created | Integer | Unique identifier of the user who deleted the Webhook |
| user_updated | Integer | Unique identifier of the user who last updated the Webhook |
| secret_key | String | Webhook Unique identifier. It is used for security to protect the URL access |
| version | String | The Webhook version |
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 |
get/hooks
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/hooks
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
List Webhooks
Changes
No recorded changes to this operation across all 1 revision of this API.