Webhooks
Update webhook
Updates a webhook for a project.
PUT
/
projects
/
{project_id}
/
webhooks
/
{id}
Update webhook
curl --request PUT \
--url https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"url": "https://new_example.com/"
}
'import requests
url = "https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id}"
payload = { "url": "https://new_example.com/" }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://new_example.com/'})
};
fetch('https://api.beyondwords.io/v1/projects/{project_id}/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.beyondwords.io/v1/projects/{project_id}/webhooks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://new_example.com/'
]),
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.beyondwords.io/v1/projects/{project_id}/webhooks/{id}"
payload := strings.NewReader("{\n \"url\": \"https://new_example.com/\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://new_example.com/\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://new_example.com/\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"url": "https://example.com/",
"enabled": true,
"use_static_ip": false,
"headers": {
"Authorization": "Bearer xxxxxx",
"X-My-Custom-Header-Y": "yyyyyy",
"X-My-Custom-Header-Z": "zzzzzz"
},
"created": "2022-01-02 23:59:59 UTC",
"updated": "2022-03-04 00:00:00 UTC"
}Authorizations
Response
200 - application/json
successful
Unique identifier for the object
The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS
Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true.
Whether requests to URL should originate from a static IP address.
Time at which the object was created (ISO 8601)
Time at which the object was updated (ISO 8601)
Was this page helpful?
⌘I
Update webhook
curl --request PUT \
--url https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"url": "https://new_example.com/"
}
'import requests
url = "https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id}"
payload = { "url": "https://new_example.com/" }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://new_example.com/'})
};
fetch('https://api.beyondwords.io/v1/projects/{project_id}/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.beyondwords.io/v1/projects/{project_id}/webhooks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://new_example.com/'
]),
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.beyondwords.io/v1/projects/{project_id}/webhooks/{id}"
payload := strings.NewReader("{\n \"url\": \"https://new_example.com/\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://new_example.com/\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/projects/{project_id}/webhooks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://new_example.com/\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"url": "https://example.com/",
"enabled": true,
"use_static_ip": false,
"headers": {
"Authorization": "Bearer xxxxxx",
"X-My-Custom-Header-Y": "yyyyyy",
"X-My-Custom-Header-Z": "zzzzzz"
},
"created": "2022-01-02 23:59:59 UTC",
"updated": "2022-03-04 00:00:00 UTC"
}