Webhooks
Get Webhook
This endpoint retrieves data of a specific Webhook based on JSON input. The API returns a single Webhook available, according to the unique ID provided. If the specified Webhook does not exist, the response will be a "bad request".
You will only receive the Webhook 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
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Webhook |
RESPONSE
This endpoint returns information about a 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/{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
Response
Get Webhook
Changes
No recorded changes to this operation across all 1 revision of this API.