export const metadata = {
title: "Webhooks - OnlineOrNot API Documentation",
description:
"Configure webhook integrations for alert notifications",
}
## List all webhooks {{ tag: 'GET', label: '/v1/webhooks' }}
*Retrieve a paginated list of all webhooks for your organization*
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns a list of webhooks|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request GET \
--url https://api.onlineornot.com/v1/webhooks \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/webhooks", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/webhooks")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/webhooks');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/webhooks"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": [
{
"id": "a1b2c3d4",
"url": "https://api.example.com/webhooks/onlineornot",
"description": "Production webhook for incident notifications",
"events": [
"status_page.incident.started",
"status_page.incident.resolved"
],
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z",
"status_pages": [
{
"id": "x9y8z7w6",
"name": "My Status Page"
}
],
"checks": [
{
"id": "c1d2e3f4",
"name": "API Health Check"
}
],
"heartbeats": [
{
"id": "h1i2j3k4",
"name": "Daily Backup Job"
}
]
}
],
"result_info": {
"page": 1,
"per_page": 20,
"count": 1,
"total_count": 1
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Create a webhook {{ tag: 'POST', label: '/v1/webhooks' }}
*Create a new webhook to receive event notifications*
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Webhook created successfully|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden - Webhooks require a paid plan|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request POST \
--url https://api.onlineornot.com/v1/webhooks \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"url":"https://api.example.com/webhooks/onlineornot","events":["status_page.incident.started","status_page.incident.resolved"]}'
```
```javascript
fetch("https://api.onlineornot.com/v1/webhooks", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"url\":\"https://api.example.com/webhooks/onlineornot\",\"events\":[\"status_page.incident.started\",\"status_page.incident.resolved\"]}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"url\":\"https://api.example.com/webhooks/onlineornot\",\"events\":[\"status_page.incident.started\",\"status_page.incident.resolved\"]}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/webhooks")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/webhooks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"url":"https://api.example.com/webhooks/onlineornot","events":["status_page.incident.started","status_page.incident.resolved"]}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"url\":\"https://api.example.com/webhooks/onlineornot\",\"events\":[\"status_page.incident.started\",\"status_page.incident.resolved\"]}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/webhooks"
payload = {
"url": "https://api.example.com/webhooks/onlineornot",
"events": ["status_page.incident.started", "status_page.incident.resolved"]
}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"url": "https://api.example.com/webhooks/onlineornot",
"description": "Production webhook for incident notifications",
"events": [
"status_page.incident.started",
"status_page.incident.resolved"
],
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z",
"status_pages": [
{
"id": "x9y8z7w6",
"name": "My Status Page"
}
],
"checks": [
{
"id": "c1d2e3f4",
"name": "API Health Check"
}
],
"heartbeats": [
{
"id": "h1i2j3k4",
"name": "Daily Backup Job"
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Retrieve a webhook {{ tag: 'GET', label: '/v1/webhooks/{webhook_id}' }}
*Look up detailed information about a specific webhook*
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns the specified webhook|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Webhook not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request GET \
--url https://api.onlineornot.com/v1/webhooks/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/webhooks/a1b2c3d4", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/webhooks/a1b2c3d4")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/webhooks/a1b2c3d4');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/webhooks/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/webhooks/a1b2c3d4"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"url": "https://api.example.com/webhooks/onlineornot",
"description": "Production webhook for incident notifications",
"events": [
"status_page.incident.started",
"status_page.incident.resolved"
],
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z",
"status_pages": [
{
"id": "x9y8z7w6",
"name": "My Status Page"
}
],
"checks": [
{
"id": "c1d2e3f4",
"name": "API Health Check"
}
],
"heartbeats": [
{
"id": "h1i2j3k4",
"name": "Daily Backup Job"
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Modify a webhook {{ tag: 'PATCH', label: '/v1/webhooks/{webhook_id}' }}
*Update the configuration of an existing webhook*
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Webhook updated successfully|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Webhook not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request PATCH \
--url https://api.onlineornot.com/v1/webhooks/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"url":"https://api.example.com/webhooks/new-endpoint"}'
```
```javascript
fetch("https://api.onlineornot.com/v1/webhooks/a1b2c3d4", {
"method": "PATCH",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
},
"body": "{\"url\":\"https://api.example.com/webhooks/new-endpoint\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"url\":\"https://api.example.com/webhooks/new-endpoint\"}");
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/webhooks/a1b2c3d4")
.patch(body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/webhooks/a1b2c3d4');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
$request->setBody('{"url":"https://api.example.com/webhooks/new-endpoint"}');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/webhooks/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
request.body = "{\"url\":\"https://api.example.com/webhooks/new-endpoint\"}"
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/webhooks/a1b2c3d4"
payload = {"url": "https://api.example.com/webhooks/new-endpoint"}
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("PATCH", url, json=payload, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4",
"url": "https://api.example.com/webhooks/onlineornot",
"description": "Production webhook for incident notifications",
"events": [
"status_page.incident.started",
"status_page.incident.resolved"
],
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z",
"status_pages": [
{
"id": "x9y8z7w6",
"name": "My Status Page"
}
],
"checks": [
{
"id": "c1d2e3f4",
"name": "API Health Check"
}
],
"heartbeats": [
{
"id": "h1i2j3k4",
"name": "Daily Backup Job"
}
]
},
"success": true,
"errors": [],
"messages": []
}
```
---
## Delete a webhook {{ tag: 'DELETE', label: '/v1/webhooks/{webhook_id}' }}
*Permanently delete a webhook*
### Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`
Responses
|Status|Meaning|Description|
|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Returns the deleted webhook's ID|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Webhook not found|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal Server Error|
```bash {{ title: 'cURL' }}
curl --request DELETE \
--url https://api.onlineornot.com/v1/webhooks/a1b2c3d4 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
```
```javascript
fetch("https://api.onlineornot.com/v1/webhooks/a1b2c3d4", {
"method": "DELETE",
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
```
```java
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.onlineornot.com/v1/webhooks/a1b2c3d4")
.delete(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {access-token}")
.build();
Response response = client.newCall(request).execute();
```
```php
setUrl('https://api.onlineornot.com/v1/webhooks/a1b2c3d4');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
```
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.onlineornot.com/v1/webhooks/a1b2c3d4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Authorization"] = 'Bearer {access-token}'
response = http.request(request)
puts response.read_body
```
```python
import requests
url = "https://api.onlineornot.com/v1/webhooks/a1b2c3d4"
headers = {
"Accept": "application/json",
"Authorization": "Bearer {access-token}"
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```json {{ title: 'Response' }}
{
"result": {
"id": "a1b2c3d4"
},
"success": true,
"errors": [],
"messages": []
}
```
---