Update Webhook
curl --request PATCH \
--url https://api.runpulse.com/webhook/{webhook_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"events": [],
"enabled": true,
"description": "<string>",
"headers": {},
"secret": "<string>"
}
'import requests
url = "https://api.runpulse.com/webhook/{webhook_id}"
payload = {
"events": [],
"enabled": True,
"description": "<string>",
"headers": {},
"secret": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [],
enabled: true,
description: '<string>',
headers: {},
secret: '<string>'
})
};
fetch('https://api.runpulse.com/webhook/{webhook_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.runpulse.com/webhook/{webhook_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([
'events' => [
],
'enabled' => true,
'description' => '<string>',
'headers' => [
],
'secret' => '<string>'
]),
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.runpulse.com/webhook/{webhook_id}"
payload := strings.NewReader("{\n \"events\": [],\n \"enabled\": true,\n \"description\": \"<string>\",\n \"headers\": {},\n \"secret\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.runpulse.com/webhook/{webhook_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [],\n \"enabled\": true,\n \"description\": \"<string>\",\n \"headers\": {},\n \"secret\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.runpulse.com/webhook/{webhook_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [],\n \"enabled\": true,\n \"description\": \"<string>\",\n \"headers\": {},\n \"secret\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"webhook_id": "<string>",
"url": "<string>",
"events": [
"parse.queued"
],
"events_from": {},
"enabled": true,
"disabled_reason": "delivery_failures",
"header_names": [
"<string>"
],
"created_at": "<string>",
"description": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}Webhook
Update Webhook
Change a webhook. Each field you send replaces its current value. You can’t change the URL, so create another webhook instead. Turning the webhook back on with enabled: true clears disabled_reason.
PATCH
/
webhook
/
{webhook_id}
Update Webhook
curl --request PATCH \
--url https://api.runpulse.com/webhook/{webhook_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"events": [],
"enabled": true,
"description": "<string>",
"headers": {},
"secret": "<string>"
}
'import requests
url = "https://api.runpulse.com/webhook/{webhook_id}"
payload = {
"events": [],
"enabled": True,
"description": "<string>",
"headers": {},
"secret": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [],
enabled: true,
description: '<string>',
headers: {},
secret: '<string>'
})
};
fetch('https://api.runpulse.com/webhook/{webhook_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.runpulse.com/webhook/{webhook_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([
'events' => [
],
'enabled' => true,
'description' => '<string>',
'headers' => [
],
'secret' => '<string>'
]),
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.runpulse.com/webhook/{webhook_id}"
payload := strings.NewReader("{\n \"events\": [],\n \"enabled\": true,\n \"description\": \"<string>\",\n \"headers\": {},\n \"secret\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.runpulse.com/webhook/{webhook_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [],\n \"enabled\": true,\n \"description\": \"<string>\",\n \"headers\": {},\n \"secret\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.runpulse.com/webhook/{webhook_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [],\n \"enabled\": true,\n \"description\": \"<string>\",\n \"headers\": {},\n \"secret\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"webhook_id": "<string>",
"url": "<string>",
"events": [
"parse.queued"
],
"events_from": {},
"enabled": true,
"disabled_reason": "delivery_failures",
"header_names": [
"<string>"
],
"created_at": "<string>",
"description": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"retryable": true,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"retry_after": 123,
"errors": [
{
"field": "<string>",
"issue": "<string>",
"pointer": "<string>"
}
],
"resource": "<string>",
"reason": "<string>",
"parse_id": "<string>",
"extract_id": "<string>",
"split_id": "<string>",
"classify_id": "<string>",
"tables_id": "<string>",
"charts_id": "<string>",
"pipeline_id": "<string>",
"batch_id": "<string>",
"filename": "<string>",
"declared_type": "<string>",
"detected": "<string>",
"supported_types": [
"<string>"
],
"supported": [
"<string>"
],
"max_size_mb": 123,
"file_size_mb": 123,
"plan_name": "<string>",
"pages_used": 123,
"page_allowance": 123,
"upgrade_url": "<string>",
"action_required": "<string>",
"billing_info": {}
}Authorizations
Headers
Path Parameters
The webhook_id that POST /webhook returned.
Body
application/json
Changes to a webhook. Each field you send replaces its current value.
The events to send, replacing the current list. An event you add applies only to jobs created 15 seconds or more after this request.
Available options:
parse.queued, parse.processing, parse.completed, parse.failed, parse.canceled, extract.queued, extract.processing, extract.completed, extract.failed, extract.canceled, split.queued, split.processing, split.completed, split.failed, split.canceled, classify.queued, classify.processing, classify.completed, classify.failed, classify.canceled, tables.queued, tables.processing, tables.completed, tables.failed, tables.canceled, charts.queued, charts.processing, charts.completed, charts.failed, charts.canceled, pipeline.queued, pipeline.processing, pipeline.completed, pipeline.failed, pipeline.canceled Set to false to turn the webhook off, or true to turn it back on and clear disabled_reason. After 30 days off, it covers only jobs created 15 seconds or more after this request.
A new note. An empty string clears the note.
Maximum string length:
500Static headers to replace the current ones, or {} to clear them. You can set up to 5, but not Pulse's own, such as Content-Type or webhook-*. Values are encrypted and never returned.
Show child attributes
Show child attributes
A signing secret of your own, as whsec_ followed by the base64 of 24 to 64 random bytes. The previous secret keeps signing alongside it for 24 hours.
Response
The webhook, as changed.
One of your organization's webhooks, without its secret.
The webhook's id, webhook-<uuid>.
The URL Pulse sends this webhook's events to.
The events this webhook receives. An empty list means none.
Available options:
parse.queued, parse.processing, parse.completed, parse.failed, parse.canceled, extract.queued, extract.processing, extract.completed, extract.failed, extract.canceled, split.queued, split.processing, split.completed, split.failed, split.canceled, classify.queued, classify.processing, classify.completed, classify.failed, classify.canceled, tables.queued, tables.processing, tables.completed, tables.failed, tables.canceled, charts.queued, charts.processing, charts.completed, charts.failed, charts.canceled, pipeline.queued, pipeline.processing, pipeline.completed, pipeline.failed, pipeline.canceled For each event, the time it takes effect. The event is sent only for jobs created after that time.
Show child attributes
Show child attributes
Whether Pulse sends events to this webhook. It's false when you or Pulse turned the webhook off.
Why Pulse turned the webhook off: delivery_failures (10 events in a row undelivered, or 3 days of failed deliveries) or gone (your endpoint returned 410). It's null while on, or if you turned it off.
Available options:
delivery_failures, gone The names of the webhook's static headers. Their values are never returned.
When the webhook was created.
Your note about the webhook, or null if you gave none.