Webhooks - Revision history

Admin at 14:09, 14 November 2024

2024-11-14T14:09:57Z

Admin at 12:54, 24 March 2022

2022-03-24T12:54:39Z

Admin at 10:49, 4 November 2021

2021-11-04T10:49:49Z

Admin at 15:15, 3 November 2021

2021-11-03T15:15:47Z

Admin at 12:09, 20 August 2021

2021-08-20T12:09:06Z

Admin: Created page with "You can configure webhook endpoints via the API to be notified about events that happen in your Harmonizely account.
2021-08-20T10:49:59Z

Created page with "You can configure webhook endpoints via the API to be notified about events that happen in your Harmonizely account. <span style="background-color:#4dcb7b; color:white; paddi..."

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

POST'''Create a webhook'''
<pre>https://harmonizely.com/api/webhooks</pre>
Creates a new webhook object. 

'''Request'''
{| class="table" style="width:100%; border: 2px solid black;"
|-
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Headers
|-
| Content-Type REQUIRED
| <code>string</code>
| application/json
|-
| X-API-KEY REQUIRED
| <code>string</code>
| Your API key
|}
 
{| class="table" style="width:100%; border: 2px solid black;"
|-
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Body Parameters
|-
| events REQUIRED
| <code>array</code>
| The list of events to enable for this endpoint.
Possible values:<pre>
["meetingScheduled", "meetingCancelled", "meetingRescheduled"]</pre>
|-
| secret OPTIONAL
| <code>string</code>
| The endpoint's secret used to generate webhook signatures.
|-
| url REQUIRED
| <code>string</code>
| The webhook URL.
|}

'''Response''' 
<span style="width: 10px;
height: 10px;
display: inline-block;
font-size: 16px;
font-family: Content-font, Roboto, sans-serif;
font-weight: 400;
line-height: 1.625;
margin-right: 6px;
border-radius: 50%;
background-color: rgb(38, 203, 124);">201: Created 
Webhook successfully created.
<pre>
{
"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"
}
</pre>
<span style="width: 10px;
height: 10px;
display: inline-block;
font-size: 16px;
font-family: Content-font, Roboto, sans-serif;
font-weight: 400;
line-height: 1.625;
margin-right: 6px;
border-radius: 50%;
background-color: red;">422: Unprocessable Entity 
Invalid arguments.
<pre>
{
"message": "Invalid arguments",
"errors": {
"url": [
"This value is not a valid URL."
]
}
}
</pre>

GET'''List all webhooks'''
<pre>https://harmonizely.com/api/webhooks</pre>
Lists all webhooks.
'''Request'''
{| class="table" style="width:100%; border: 2px solid black;"
|-
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Headers
|-
| Content-Type REQUIRED
| <code>string</code>
| application/json
|-
| X-API-KEY REQUIRED
| <code>string</code>
| Your API key
|}

'''Response''' 
<span style="width: 10px;
height: 10px;
display: inline-block;
font-size: 16px;
font-family: Content-font, Roboto, sans-serif;
font-weight: 400;
line-height: 1.625;
margin-right: 6px;
border-radius: 50%;
background-color: rgb(38, 203, 124);">200:OK 
Returns a list of all webhooks.
<pre>
{
"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"
}
}
}
</pre>

DELETE'''Delete a webhook'''
<pre>https://harmonizely.com/api/webhooks/:id</pre>
Deletes a webhook.

'''Request'''
{| class="table" style="width:100%; border: 2px solid black;"
|-
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Path parameters
|-
| id REQUIRED
| <code>string</code>
| Unique identifier of the webhook (UUID4)
|}
 
{| class="table" style="width:100%; border: 2px solid black;"
|-
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Headers
|-
| Content-Type REQUIRED
| <code>string</code>
| application/json
|-
| X-API-KEY REQUIRED
| <code>string</code>
| Your API key
|}

'''Response''' 
<span style="width: 10px;
height: 10px;
display: inline-block;
font-size: 16px;
font-family: Content-font, Roboto, sans-serif;
font-weight: 400;
line-height: 1.625;
margin-right: 6px;
border-radius: 50%;
background-color: rgb(38, 203, 124);">204:No Content 
Webhook successfully deleted.
<pre>

</pre>
<span style="width: 10px;
height: 10px;
display: inline-block;
font-size: 16px;
font-family: Content-font, Roboto, sans-serif;
font-weight: 400;
line-height: 1.625;
margin-right: 6px;
border-radius: 50%;
background-color: red;">404:Not Found 
Webhook not found.
<pre>
{
"code": 404,
"message": "Not found."
}</pre>