Difference between revisions of "Webhooks"
From SimplyMeet.me
(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...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | You can configure webhook endpoints via the API to be notified about events that happen in your | + | You can configure webhook endpoints via the API to be notified about events that happen in your SimplyMeet.me account. |
<span style="background-color:#4dcb7b; color:white; padding:5px; border-radius:15px;">POST</span>'''Create a webhook''' | <span style="background-color:#4dcb7b; color:white; padding:5px; border-radius:15px;">POST</span>'''Create a webhook''' | ||
| − | <pre>https:// | + | <pre>https://secure.simplymeet.me/api/webhooks</pre> |
Creates a new webhook object.<br> | Creates a new webhook object.<br> | ||
| Line 29: | Line 29: | ||
["meetingScheduled", "meetingCancelled", "meetingRescheduled"]</pre> | ["meetingScheduled", "meetingCancelled", "meetingRescheduled"]</pre> | ||
|- | |- | ||
| − | | secret<br><span style="font-size:10px; color: | + | | secret<br><span style="font-size:10px; color:red;">REQUIRED</span> |
| <code>string</code> | | <code>string</code> | ||
| The endpoint's secret used to generate webhook signatures. | | The endpoint's secret used to generate webhook signatures. | ||
| Line 88: | Line 88: | ||
<span style="background-color:#3158e2; color:white; padding:5px; border-radius:15px;">GET</span>'''List all webhooks''' | <span style="background-color:#3158e2; color:white; padding:5px; border-radius:15px;">GET</span>'''List all webhooks''' | ||
| − | <pre>https:// | + | <pre>https://secure.simplymeet.me/api/webhooks</pre> |
Lists all webhooks. | Lists all webhooks. | ||
'''Request''' | '''Request''' | ||
| Line 154: | Line 154: | ||
<span style="background-color:red; color:white; padding:5px; border-radius:15px;">DELETE</span>'''Delete a webhook''' | <span style="background-color:red; color:white; padding:5px; border-radius:15px;">DELETE</span>'''Delete a webhook''' | ||
| − | <pre>https:// | + | <pre>https://secure.simplymeet.me/api/webhooks/:id</pre> |
Deletes a webhook. | Deletes a webhook. | ||
Latest revision as of 14:09, 14 November 2024
You can configure webhook endpoints via the API to be notified about events that happen in your SimplyMeet.me account.
POSTCreate a webhook
https://secure.simplymeet.me/api/webhooks
Creates a new webhook object.
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 REQUIRED |
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."
]
}
}
GETList all webhooks
https://secure.simplymeet.me/api/webhooks
Lists all webhooks. 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"
}
}
}
DELETEDelete a webhook
https://secure.simplymeet.me/api/webhooks/:id
Deletes a webhook.
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."
}
