Update webhook
curl --request PATCH \
--url https://api.onset.io/v1/webhooks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"events": {
"release.created": true,
"release.updated": true,
"release.deleted": false,
"release.published": true,
"release.scheduled": false,
"release.reverted": false,
"release.reacted": false,
"release.unreacted": false,
"milestone.created": true,
"milestone.updated": true,
"milestone.deleted": false,
"milestone.upvoted": false,
"milestone.downvoted": false,
"milestone.archived": false,
"milestone.unarchived": false,
"subscriber.created": false,
"subscriber.updated": false,
"subscriber.deleted": false,
"subscriber.unsubscribed": false
}
}
'import requests
url = "https://api.onset.io/v1/webhooks/{id}"
payload = {
"name": "<string>",
"url": "<string>",
"events": {
"release.created": True,
"release.updated": True,
"release.deleted": False,
"release.published": True,
"release.scheduled": False,
"release.reverted": False,
"release.reacted": False,
"release.unreacted": False,
"milestone.created": True,
"milestone.updated": True,
"milestone.deleted": False,
"milestone.upvoted": False,
"milestone.downvoted": False,
"milestone.archived": False,
"milestone.unarchived": False,
"subscriber.created": False,
"subscriber.updated": False,
"subscriber.deleted": False,
"subscriber.unsubscribed": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
events: {
'release.created': true,
'release.updated': true,
'release.deleted': false,
'release.published': true,
'release.scheduled': false,
'release.reverted': false,
'release.reacted': false,
'release.unreacted': false,
'milestone.created': true,
'milestone.updated': true,
'milestone.deleted': false,
'milestone.upvoted': false,
'milestone.downvoted': false,
'milestone.archived': false,
'milestone.unarchived': false,
'subscriber.created': false,
'subscriber.updated': false,
'subscriber.deleted': false,
'subscriber.unsubscribed': false
}
})
};
fetch('https://api.onset.io/v1/webhooks/{id}', 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.onset.io/v1/webhooks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'events' => [
'release.created' => true,
'release.updated' => true,
'release.deleted' => false,
'release.published' => true,
'release.scheduled' => false,
'release.reverted' => false,
'release.reacted' => false,
'release.unreacted' => false,
'milestone.created' => true,
'milestone.updated' => true,
'milestone.deleted' => false,
'milestone.upvoted' => false,
'milestone.downvoted' => false,
'milestone.archived' => false,
'milestone.unarchived' => false,
'subscriber.created' => false,
'subscriber.updated' => false,
'subscriber.deleted' => false,
'subscriber.unsubscribed' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.onset.io/v1/webhooks/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": {\n \"release.created\": true,\n \"release.updated\": true,\n \"release.deleted\": false,\n \"release.published\": true,\n \"release.scheduled\": false,\n \"release.reverted\": false,\n \"release.reacted\": false,\n \"release.unreacted\": false,\n \"milestone.created\": true,\n \"milestone.updated\": true,\n \"milestone.deleted\": false,\n \"milestone.upvoted\": false,\n \"milestone.downvoted\": false,\n \"milestone.archived\": false,\n \"milestone.unarchived\": false,\n \"subscriber.created\": false,\n \"subscriber.updated\": false,\n \"subscriber.deleted\": false,\n \"subscriber.unsubscribed\": false\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.onset.io/v1/webhooks/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": {\n \"release.created\": true,\n \"release.updated\": true,\n \"release.deleted\": false,\n \"release.published\": true,\n \"release.scheduled\": false,\n \"release.reverted\": false,\n \"release.reacted\": false,\n \"release.unreacted\": false,\n \"milestone.created\": true,\n \"milestone.updated\": true,\n \"milestone.deleted\": false,\n \"milestone.upvoted\": false,\n \"milestone.downvoted\": false,\n \"milestone.archived\": false,\n \"milestone.unarchived\": false,\n \"subscriber.created\": false,\n \"subscriber.updated\": false,\n \"subscriber.deleted\": false,\n \"subscriber.unsubscribed\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onset.io/v1/webhooks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": {\n \"release.created\": true,\n \"release.updated\": true,\n \"release.deleted\": false,\n \"release.published\": true,\n \"release.scheduled\": false,\n \"release.reverted\": false,\n \"release.reacted\": false,\n \"release.unreacted\": false,\n \"milestone.created\": true,\n \"milestone.updated\": true,\n \"milestone.deleted\": false,\n \"milestone.upvoted\": false,\n \"milestone.downvoted\": false,\n \"milestone.archived\": false,\n \"milestone.unarchived\": false,\n \"subscriber.created\": false,\n \"subscriber.updated\": false,\n \"subscriber.deleted\": false,\n \"subscriber.unsubscribed\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"events": {
"release.created": true,
"release.updated": true,
"release.deleted": false,
"release.published": true,
"release.scheduled": false,
"release.reverted": false,
"release.reacted": false,
"release.unreacted": false,
"milestone.created": true,
"milestone.updated": true,
"milestone.deleted": false,
"milestone.upvoted": false,
"milestone.downvoted": false,
"milestone.archived": false,
"milestone.unarchived": false,
"subscriber.created": false,
"subscriber.updated": false,
"subscriber.deleted": false,
"subscriber.unsubscribed": false
},
"last_triggered_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Webhooks
Update webhook
Update an existing webhook
PATCH
/
webhooks
/
{id}
Update webhook
curl --request PATCH \
--url https://api.onset.io/v1/webhooks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"events": {
"release.created": true,
"release.updated": true,
"release.deleted": false,
"release.published": true,
"release.scheduled": false,
"release.reverted": false,
"release.reacted": false,
"release.unreacted": false,
"milestone.created": true,
"milestone.updated": true,
"milestone.deleted": false,
"milestone.upvoted": false,
"milestone.downvoted": false,
"milestone.archived": false,
"milestone.unarchived": false,
"subscriber.created": false,
"subscriber.updated": false,
"subscriber.deleted": false,
"subscriber.unsubscribed": false
}
}
'import requests
url = "https://api.onset.io/v1/webhooks/{id}"
payload = {
"name": "<string>",
"url": "<string>",
"events": {
"release.created": True,
"release.updated": True,
"release.deleted": False,
"release.published": True,
"release.scheduled": False,
"release.reverted": False,
"release.reacted": False,
"release.unreacted": False,
"milestone.created": True,
"milestone.updated": True,
"milestone.deleted": False,
"milestone.upvoted": False,
"milestone.downvoted": False,
"milestone.archived": False,
"milestone.unarchived": False,
"subscriber.created": False,
"subscriber.updated": False,
"subscriber.deleted": False,
"subscriber.unsubscribed": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
events: {
'release.created': true,
'release.updated': true,
'release.deleted': false,
'release.published': true,
'release.scheduled': false,
'release.reverted': false,
'release.reacted': false,
'release.unreacted': false,
'milestone.created': true,
'milestone.updated': true,
'milestone.deleted': false,
'milestone.upvoted': false,
'milestone.downvoted': false,
'milestone.archived': false,
'milestone.unarchived': false,
'subscriber.created': false,
'subscriber.updated': false,
'subscriber.deleted': false,
'subscriber.unsubscribed': false
}
})
};
fetch('https://api.onset.io/v1/webhooks/{id}', 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.onset.io/v1/webhooks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'events' => [
'release.created' => true,
'release.updated' => true,
'release.deleted' => false,
'release.published' => true,
'release.scheduled' => false,
'release.reverted' => false,
'release.reacted' => false,
'release.unreacted' => false,
'milestone.created' => true,
'milestone.updated' => true,
'milestone.deleted' => false,
'milestone.upvoted' => false,
'milestone.downvoted' => false,
'milestone.archived' => false,
'milestone.unarchived' => false,
'subscriber.created' => false,
'subscriber.updated' => false,
'subscriber.deleted' => false,
'subscriber.unsubscribed' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.onset.io/v1/webhooks/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": {\n \"release.created\": true,\n \"release.updated\": true,\n \"release.deleted\": false,\n \"release.published\": true,\n \"release.scheduled\": false,\n \"release.reverted\": false,\n \"release.reacted\": false,\n \"release.unreacted\": false,\n \"milestone.created\": true,\n \"milestone.updated\": true,\n \"milestone.deleted\": false,\n \"milestone.upvoted\": false,\n \"milestone.downvoted\": false,\n \"milestone.archived\": false,\n \"milestone.unarchived\": false,\n \"subscriber.created\": false,\n \"subscriber.updated\": false,\n \"subscriber.deleted\": false,\n \"subscriber.unsubscribed\": false\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.onset.io/v1/webhooks/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": {\n \"release.created\": true,\n \"release.updated\": true,\n \"release.deleted\": false,\n \"release.published\": true,\n \"release.scheduled\": false,\n \"release.reverted\": false,\n \"release.reacted\": false,\n \"release.unreacted\": false,\n \"milestone.created\": true,\n \"milestone.updated\": true,\n \"milestone.deleted\": false,\n \"milestone.upvoted\": false,\n \"milestone.downvoted\": false,\n \"milestone.archived\": false,\n \"milestone.unarchived\": false,\n \"subscriber.created\": false,\n \"subscriber.updated\": false,\n \"subscriber.deleted\": false,\n \"subscriber.unsubscribed\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onset.io/v1/webhooks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"events\": {\n \"release.created\": true,\n \"release.updated\": true,\n \"release.deleted\": false,\n \"release.published\": true,\n \"release.scheduled\": false,\n \"release.reverted\": false,\n \"release.reacted\": false,\n \"release.unreacted\": false,\n \"milestone.created\": true,\n \"milestone.updated\": true,\n \"milestone.deleted\": false,\n \"milestone.upvoted\": false,\n \"milestone.downvoted\": false,\n \"milestone.archived\": false,\n \"milestone.unarchived\": false,\n \"subscriber.created\": false,\n \"subscriber.updated\": false,\n \"subscriber.deleted\": false,\n \"subscriber.unsubscribed\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"events": {
"release.created": true,
"release.updated": true,
"release.deleted": false,
"release.published": true,
"release.scheduled": false,
"release.reverted": false,
"release.reacted": false,
"release.unreacted": false,
"milestone.created": true,
"milestone.updated": true,
"milestone.deleted": false,
"milestone.upvoted": false,
"milestone.downvoted": false,
"milestone.archived": false,
"milestone.unarchived": false,
"subscriber.created": false,
"subscriber.updated": false,
"subscriber.deleted": false,
"subscriber.unsubscribed": false
},
"last_triggered_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Webhook ID
Body
application/json
Partial update. Every field is optional and any field you omit is left unchanged. If you send events, it must subscribe to at least one event.
Webhook name
Required string length:
3 - 50Webhook URL endpoint
Webhook event subscriptions
Show child attributes
Show child attributes
Example:
{
"release.created": true,
"release.updated": true,
"release.deleted": false,
"release.published": true,
"release.scheduled": false,
"release.reverted": false,
"release.reacted": false,
"release.unreacted": false,
"milestone.created": true,
"milestone.updated": true,
"milestone.deleted": false,
"milestone.upvoted": false,
"milestone.downvoted": false,
"milestone.archived": false,
"milestone.unarchived": false,
"subscriber.created": false,
"subscriber.updated": false,
"subscriber.deleted": false,
"subscriber.unsubscribed": false
}
Response
Webhook updated successfully
Unique webhook identifier
Webhook name
Webhook URL endpoint
Webhook event subscriptions
Show child attributes
Show child attributes
Example:
{
"release.created": true,
"release.updated": true,
"release.deleted": false,
"release.published": true,
"release.scheduled": false,
"release.reverted": false,
"release.reacted": false,
"release.unreacted": false,
"milestone.created": true,
"milestone.updated": true,
"milestone.deleted": false,
"milestone.upvoted": false,
"milestone.downvoted": false,
"milestone.archived": false,
"milestone.unarchived": false,
"subscriber.created": false,
"subscriber.updated": false,
"subscriber.deleted": false,
"subscriber.unsubscribed": false
}
When the webhook was last triggered
When the webhook was created
When the webhook was last updated
Was this page helpful?