Create Webhook
POST
/
webhooks
Create Webhook
curl --request POST \
--url https://api.monime.io/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'Monime-Space-Id: <monime-space-id>' \
--data '
{
"name": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"isActive": false,
"apiVersion": "<string>",
"alertEmails": [
"<string>"
],
"verificationMethod": {},
"customHeaders": {},
"metadata": {}
}
'import requests
url = "https://api.monime.io/webhooks"
payload = {
"name": "<string>",
"url": "<string>",
"events": ["<string>"],
"isActive": False,
"apiVersion": "<string>",
"alertEmails": ["<string>"],
"verificationMethod": {},
"customHeaders": {},
"metadata": {}
}
headers = {
"Monime-Space-Id": "<monime-space-id>",
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Monime-Space-Id': '<monime-space-id>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
url: '<string>',
events: ['<string>'],
isActive: false,
apiVersion: '<string>',
alertEmails: ['<string>'],
verificationMethod: {},
customHeaders: {},
metadata: {}
})
};
fetch('https://api.monime.io/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.monime.io/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'events' => [
'<string>'
],
'isActive' => false,
'apiVersion' => '<string>',
'alertEmails' => [
'<string>'
],
'verificationMethod' => [
],
'customHeaders' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"Monime-Space-Id: <monime-space-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.monime.io/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"isActive\": false,\n \"apiVersion\": \"<string>\",\n \"alertEmails\": [\n \"<string>\"\n ],\n \"verificationMethod\": {},\n \"customHeaders\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Monime-Space-Id", "<monime-space-id>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.monime.io/webhooks")
.header("Monime-Space-Id", "<monime-space-id>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"isActive\": false,\n \"apiVersion\": \"<string>\",\n \"alertEmails\": [\n \"<string>\"\n ],\n \"verificationMethod\": {},\n \"customHeaders\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monime.io/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"isActive\": false,\n \"apiVersion\": \"<string>\",\n \"alertEmails\": [\n \"<string>\"\n ],\n \"verificationMethod\": {},\n \"customHeaders\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"messages": [
"<unknown>"
],
"result": {
"name": "My Ecommerce Webhook",
"url": "<string>",
"events": [
"<string>"
],
"id": "<string>",
"isActive": true,
"apiVersion": "<string>",
"alertEmails": [
"<string>"
],
"verificationMethod": {
"hmac256": {
"secret": "<string>"
}
},
"customHeaders": {},
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}Authorizations
Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>
Headers
The value is the tenancy parameter that Monime used to determine which space the request is intended for.
Maximum string length:
100Pattern:
^spc-.*$This header is used to uniquely identify a request, ensuring that the operation is not performed more than once during retries.
Maximum string length:
64Body
application/json
The name of the webhook.
Required string length:
1 - 100The URL of the webhook
The list of events the webhook is subscribed to.
Required array length:
1 - 100 elementsDenotes whether the webhook is active.
The API version the webhook supports.
The list email address to send alert notifications to when the webhook is failing.
Maximum array length:
3The verification method of the webhook.
Show child attributes
Show child attributes
Custom headers of the webhook.
Show child attributes
Show child attributes
Metadata attributes of the webhook.
Response
200 - application/json
OK
Was this page helpful?
⌘I
Create Webhook
curl --request POST \
--url https://api.monime.io/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'Monime-Space-Id: <monime-space-id>' \
--data '
{
"name": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"isActive": false,
"apiVersion": "<string>",
"alertEmails": [
"<string>"
],
"verificationMethod": {},
"customHeaders": {},
"metadata": {}
}
'import requests
url = "https://api.monime.io/webhooks"
payload = {
"name": "<string>",
"url": "<string>",
"events": ["<string>"],
"isActive": False,
"apiVersion": "<string>",
"alertEmails": ["<string>"],
"verificationMethod": {},
"customHeaders": {},
"metadata": {}
}
headers = {
"Monime-Space-Id": "<monime-space-id>",
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Monime-Space-Id': '<monime-space-id>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
url: '<string>',
events: ['<string>'],
isActive: false,
apiVersion: '<string>',
alertEmails: ['<string>'],
verificationMethod: {},
customHeaders: {},
metadata: {}
})
};
fetch('https://api.monime.io/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.monime.io/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'events' => [
'<string>'
],
'isActive' => false,
'apiVersion' => '<string>',
'alertEmails' => [
'<string>'
],
'verificationMethod' => [
],
'customHeaders' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"Monime-Space-Id: <monime-space-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.monime.io/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"isActive\": false,\n \"apiVersion\": \"<string>\",\n \"alertEmails\": [\n \"<string>\"\n ],\n \"verificationMethod\": {},\n \"customHeaders\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Monime-Space-Id", "<monime-space-id>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.monime.io/webhooks")
.header("Monime-Space-Id", "<monime-space-id>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"isActive\": false,\n \"apiVersion\": \"<string>\",\n \"alertEmails\": [\n \"<string>\"\n ],\n \"verificationMethod\": {},\n \"customHeaders\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.monime.io/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"isActive\": false,\n \"apiVersion\": \"<string>\",\n \"alertEmails\": [\n \"<string>\"\n ],\n \"verificationMethod\": {},\n \"customHeaders\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"messages": [
"<unknown>"
],
"result": {
"name": "My Ecommerce Webhook",
"url": "<string>",
"events": [
"<string>"
],
"id": "<string>",
"isActive": true,
"apiVersion": "<string>",
"alertEmails": [
"<string>"
],
"verificationMethod": {
"hmac256": {
"secret": "<string>"
}
},
"customHeaders": {},
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}