Webhooks

You can configure webhook endpoints via the API to be notified about events that happen in your Harmonizely account.

post
Create a webhook

https://harmonizely.com/api/webhooks
Creates a new webhook object.
Request
Response
Request
Headers
Content-Type
required
string
application/json
X-API-KEY
required
string
Your API key
Body Parameters
events
required
array
The list of events to enable for this endpoint. Possible values: ["meetingScheduled", "meetingCancelled", "meetingRescheduled"]
secret
optional
string
The endpoint's secret used to generate webhook signatures.
url
required
string
The webhook URL.
Response
201: Created
Webhook successfully created.
{
"events": [
"meetingScheduled",
"meetingCancelled",
"meetingRescheduled"
],
"url": "https://example.com/webhook",
"secret": "something",
"created_at": "2021-05-25T06:17:58+00:00",
"uuid": "3e687c78-a8b8-4837-9333-57e3d807e61c"
}
422: Unprocessable Entity
Invalid arguments.
{
"message": "Invalid arguments",
"errors": {
"url": [
"This value is not a valid URL."
]
}
}

get
List all webhooks

https://harmonizely.com/api/webhooks
Lists all webhooks.
Request
Response
Request
Headers
Content-Type
required
string
application/json
X-API-KEY
required
string
Your API key
Response
200: OK
Returns a list of all webhooks.
{
"page": 1,
"limit": 10,
"pages": 1,
"total": 1,
"_embedded": {
"items": [
{
"events": [
"meetingRescheduled",
"meetingCancelled",
"meetingScheduled"
],
"url": "https://example.com/webhook",
"secret": null,
"created_at": "2021-05-24T11:04:11+00:00",
"uuid": "2ba9ee0b-e62a-43bd-aed0-31b26056ecdc"
}
]
},
"_links": {
"self": {
"href": "/api/webhooks?page=1&limit=10"
},
"first": {
"href": "/api/webhooks?page=1&limit=10"
},
"last": {
"href": "/api/webhooks?page=1&limit=10"
}
}
}

delete
Delete a webhook

https://harmonizely.com/api/webhooks/:id
Deletes a webhook.
Request
Response
Request
Path Parameters
id
required
string
Unique identifier of the webhook (UUID4)
Headers
Content-Type
required
string
application/json
X-API-KEY
required
string
Your API key.
Response
204: No Content
Webhook successfully deleted.
404: Not Found
Webhook not found.
{
"code": 404,
"message": "Not found."
}