Webhooks
Create Webhook
POST
/
webhooks
Create a webhook
curl --request POST \
--url https://api.arnio.co/api/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data @- <<EOF
{
"companyName": "Company name of webhook",
"url": "Endpoint of webhook",
"eventTypes": "Event types to listen for webhook e.g. ['new-message', 'updated-message']",
"phoneNumber": "Assigned phone number"
}
EOFimport requests
url = "https://api.arnio.co/api/v1/webhooks"
payload = {
"companyName": "Company name of webhook",
"url": "Endpoint of webhook",
"eventTypes": "Event types to listen for webhook e.g. ['new-message', 'updated-message']",
"phoneNumber": "Assigned phone number"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyName: 'Company name of webhook',
url: 'Endpoint of webhook',
eventTypes: 'Event types to listen for webhook e.g. [\'new-message\', \'updated-message\']',
phoneNumber: 'Assigned phone number'
})
};
fetch('https://api.arnio.co/api/v1/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.arnio.co/api/v1/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([
'companyName' => 'Company name of webhook',
'url' => 'Endpoint of webhook',
'eventTypes' => 'Event types to listen for webhook e.g. [\'new-message\', \'updated-message\']',
'phoneNumber' => 'Assigned phone number'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.arnio.co/api/v1/webhooks"
payload := strings.NewReader("{\n \"companyName\": \"Company name of webhook\",\n \"url\": \"Endpoint of webhook\",\n \"eventTypes\": \"Event types to listen for webhook e.g. ['new-message', 'updated-message']\",\n \"phoneNumber\": \"Assigned phone number\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.arnio.co/api/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"Company name of webhook\",\n \"url\": \"Endpoint of webhook\",\n \"eventTypes\": \"Event types to listen for webhook e.g. ['new-message', 'updated-message']\",\n \"phoneNumber\": \"Assigned phone number\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arnio.co/api/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyName\": \"Company name of webhook\",\n \"url\": \"Endpoint of webhook\",\n \"eventTypes\": \"Event types to listen for webhook e.g. ['new-message', 'updated-message']\",\n \"phoneNumber\": \"Assigned phone number\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Webhook created successfully",
"data": {
"id": "webhook-123",
"companyName": "My Company",
"url": "https://example.com/webhooks",
"eventTypes": [
"new-message",
"update-message"
]
}
}Create a new webhook to listen events from Arnio.
Authorizations
Provide your generated API Key.
Body
application/json
Response
200 - application/json
Webhook created successfully
⌘I
Create a webhook
curl --request POST \
--url https://api.arnio.co/api/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data @- <<EOF
{
"companyName": "Company name of webhook",
"url": "Endpoint of webhook",
"eventTypes": "Event types to listen for webhook e.g. ['new-message', 'updated-message']",
"phoneNumber": "Assigned phone number"
}
EOFimport requests
url = "https://api.arnio.co/api/v1/webhooks"
payload = {
"companyName": "Company name of webhook",
"url": "Endpoint of webhook",
"eventTypes": "Event types to listen for webhook e.g. ['new-message', 'updated-message']",
"phoneNumber": "Assigned phone number"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyName: 'Company name of webhook',
url: 'Endpoint of webhook',
eventTypes: 'Event types to listen for webhook e.g. [\'new-message\', \'updated-message\']',
phoneNumber: 'Assigned phone number'
})
};
fetch('https://api.arnio.co/api/v1/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.arnio.co/api/v1/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([
'companyName' => 'Company name of webhook',
'url' => 'Endpoint of webhook',
'eventTypes' => 'Event types to listen for webhook e.g. [\'new-message\', \'updated-message\']',
'phoneNumber' => 'Assigned phone number'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.arnio.co/api/v1/webhooks"
payload := strings.NewReader("{\n \"companyName\": \"Company name of webhook\",\n \"url\": \"Endpoint of webhook\",\n \"eventTypes\": \"Event types to listen for webhook e.g. ['new-message', 'updated-message']\",\n \"phoneNumber\": \"Assigned phone number\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.arnio.co/api/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"Company name of webhook\",\n \"url\": \"Endpoint of webhook\",\n \"eventTypes\": \"Event types to listen for webhook e.g. ['new-message', 'updated-message']\",\n \"phoneNumber\": \"Assigned phone number\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arnio.co/api/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyName\": \"Company name of webhook\",\n \"url\": \"Endpoint of webhook\",\n \"eventTypes\": \"Event types to listen for webhook e.g. ['new-message', 'updated-message']\",\n \"phoneNumber\": \"Assigned phone number\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Webhook created successfully",
"data": {
"id": "webhook-123",
"companyName": "My Company",
"url": "https://example.com/webhooks",
"eventTypes": [
"new-message",
"update-message"
]
}
}