# WebhooksApi
All URIs are relative to https://api.salestim.io/api/v1.0
| Method | HTTP request | Description |
|---|---|---|
| createHook | POST /hooks | Create a new webhook |
| deleteHook | DELETE /hooks/{hookId} | Delete a webhook |
| generateHookSignature | POST /hooks/signature | Generate a signature from a secret and a webhook payload |
| getHooksEvents | GET /webhooks/events | Get webhooks events |
# createHook
Hook createHook(HookPayload)
Create a new webhook
Create a new webhook. TIER 2️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| HookPayload | HookPayload | A HookPayload object. |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# deleteHook
Hook deleteHook(hookId)
Delete a webhook
Delete a webhook. TIER 2️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| hookId | String | ID of the webhook to be deleted. | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# generateHookSignature
HookSignature generateHookSignature(HookSignatureRequest)
Generate a signature from a secret and a webhook payload
Generate a signature from a secret and a webhook payload. TIER 3️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| HookSignatureRequest | HookSignatureRequest | A HookSignatureRequest object comprised of the secret and payload. |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# getHooksEvents
HooksEvents getHooksEvents()
Get webhooks events
Get webhooks events. TIER 3️⃣ | ROLES - AUTHENTICATED_USER.
# Parameters
This endpoint does not need any parameter.
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json