Webhooks
You can configure webhook endpoints via the API to be notified about events that happen in your Harmonizely account.
Create a webhook
POST
https://harmonizely.com/api/webhooks
Creates a new webhook object.
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
X-API-KEY | string | Your API key |
Request Body
Name | Type | Description |
---|---|---|
events | array | The list of events to enable for this endpoint.
Possible values:
|
secret | string | The endpoint's secret used to generate webhook signatures. |
url | string | The webhook URL. |
List all webhooks
GET
https://harmonizely.com/api/webhooks
Lists all webhooks.
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
X-API-KEY | string | Your API key |
Delete a webhook
DELETE
https://harmonizely.com/api/webhooks/:id
Deletes a webhook.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Unique identifier of the webhook (UUID4) |
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
X-API-KEY | string | Your API key. |
Last updated