VendorWebhooksApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createVendorWebhook | POST /vendors/{vendor_id}/webhooks | Create a new webhook |
| deleteVendorWebhook | DELETE /vendors/{vendor_id}/webhooks/{webhook_id} | Delete a webhook |
| getVendorWebhook | GET /vendors/{vendor_id}/webhooks/{webhook_id} | Get a specific webhook |
| listVendorWebhookEvents | GET /vendors/{vendor_id}/webhooks/events | List available webhook events |
| listVendorWebhooks | GET /vendors/{vendor_id}/webhooks | List webhooks for a vendor |
| regenerateVendorWebhookSecret | POST /vendors/{vendor_id}/webhooks/{webhook_id}/regenerate_secret | Regenerate webhook secret |
| updateVendorWebhook | PUT /vendors/{vendor_id}/webhooks/{webhook_id} | Update a webhook |
| validateVendorWebhookUrl | POST /vendors/{vendor_id}/webhooks/validate_url | Validate a webhook URL |
createVendorWebhook
VendorWebhookWithSecretResponse createVendorWebhook(vendor_id, CreateVendorWebhookRequest)
Create a new webhook
Creates a new webhook for the vendor. Returns the webhook details including the secret, which is only shown once at creation time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| CreateVendorWebhookRequest | CreateVendorWebhookRequest |
Return type
VendorWebhookWithSecretResponse
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteVendorWebhook
MessageResponse deleteVendorWebhook(vendor_id, webhook_id)
Delete a webhook
Permanently deletes a webhook. This will stop all event deliveries to the webhook URL.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| webhook_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorWebhook
VendorWebhookResponse getVendorWebhook(vendor_id, webhook_id)
Get a specific webhook
Retrieves details of a specific webhook by its ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| webhook_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorWebhookEvents
WebhookEventsResponse listVendorWebhookEvents(vendor_id)
List available webhook events
Returns a list of all available webhook event types that can be subscribed to.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorWebhooks
PaginatedResponse_VendorWebhookResponse listVendorWebhooks(vendor_id, page, per_page)
List webhooks for a vendor
Retrieves a paginated list of webhooks registered for the specified vendor.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_VendorWebhookResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
regenerateVendorWebhookSecret
RegenerateWebhookSecretResponse regenerateVendorWebhookSecret(vendor_id, webhook_id)
Regenerate webhook secret
Generates a new secret for the webhook. The old secret will be invalidated immediately. The new secret is only shown once.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| webhook_id | Long | [default to null] |
Return type
RegenerateWebhookSecretResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateVendorWebhook
VendorWebhookResponse updateVendorWebhook(vendor_id, webhook_id, UpdateVendorWebhookRequest)
Update a webhook
Updates an existing webhook’s details. Note that the secret cannot be changed through this endpoint; use the regenerate secret endpoint instead.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| webhook_id | Long | [default to null] | |
| UpdateVendorWebhookRequest | UpdateVendorWebhookRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
validateVendorWebhookUrl
ValidateWebhookUrlResponse validateVendorWebhookUrl(vendor_id, ValidateWebhookUrlRequest)
Validate a webhook URL
Tests if a webhook URL is reachable and responds correctly. Sends a test POST request to the URL and reports the response.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| ValidateWebhookUrlRequest | ValidateWebhookUrlRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8