Interceptors
Update interceptor
Updates an interceptor’s field mapping or response behavior.
PATCH
/
api
/
admin
/
interceptors
/
{id}
Update interceptor
curl --request PATCH \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"context": "checkout",
"description": "Checkout flow interceptor",
"destination": {
"timeout_ms": 5000,
"url": "https://psp.example.com/payments"
},
"field_mapping": [
{}
],
"responses": {}
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload = {
"active": True,
"context": "checkout",
"description": "Checkout flow interceptor",
"destination": {
"timeout_ms": 5000,
"url": "https://psp.example.com/payments"
},
"field_mapping": [{}],
"responses": {}
}
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({
active: true,
context: 'checkout',
description: 'Checkout flow interceptor',
destination: {timeout_ms: 5000, url: 'https://psp.example.com/payments'},
field_mapping: [{}],
responses: {}
})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{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([
'active' => true,
'context' => 'checkout',
'description' => 'Checkout flow interceptor',
'destination' => [
'timeout_ms' => 5000,
'url' => 'https://psp.example.com/payments'
],
'field_mapping' => [
[
]
],
'responses' => [
]
]),
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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload := strings.NewReader("{\n \"active\": true,\n \"context\": \"checkout\",\n \"description\": \"Checkout flow interceptor\",\n \"destination\": {\n \"timeout_ms\": 5000,\n \"url\": \"https://psp.example.com/payments\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"context\": \"checkout\",\n \"description\": \"Checkout flow interceptor\",\n \"destination\": {\n \"timeout_ms\": 5000,\n \"url\": \"https://psp.example.com/payments\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{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 \"active\": true,\n \"context\": \"checkout\",\n \"description\": \"Checkout flow interceptor\",\n \"destination\": {\n \"timeout_ms\": 5000,\n \"url\": \"https://psp.example.com/payments\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "5c9e1b3d-8f4a-4b6c-9d2e-7a5f3c1e8b4d",
"context": "checkout",
"description": "Checkout flow interceptor",
"destination": {
"timeout_ms": 30000,
"url": "https://checkout.example.com/payments"
},
"discovered_keys": [
{
"key": "$.device.ip",
"type": "string"
}
],
"field_mapping": [
{}
],
"inserted_at": "2026-03-01T09:00:00Z",
"ref": "checkout-interceptor",
"responses": null,
"updated_at": "2026-03-01T09:00:00Z",
"version": 3
}{
"classifier": "UNAUTHORIZED",
"code": 401,
"message": "No valid means of authentication was provided"
}{
"classifier": "FORBIDDEN",
"code": 403,
"message": "Not allowed to access this resource or feature"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "must be a positive integer",
"path": "limit"
}
]
}Authorizations
HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).
Path Parameters
Body
application/json
Update attributes
Response
Updated interceptor
Example:
"5c9e1b3d-8f4a-4b6c-9d2e-7a5f3c1e8b4d"
Example:
"checkout"
Example:
"Checkout flow interceptor"
Show child attributes
Show child attributes
Typed JSONPath keys observed in intercepted requests. Used for field mapping discovery.
Show child attributes
Show child attributes
Example:
"2026-03-01T09:00:00Z"
Stable identifier shared across all versions of this interceptor. Used as the path parameter for the runtime execute endpoint.
Example:
"checkout-interceptor"
Example:
null
Available options:
DRAFT, ACTIVE, INACTIVE Example:
"2026-03-01T09:00:00Z"
Example:
3
⌘I
Update interceptor
curl --request PATCH \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"context": "checkout",
"description": "Checkout flow interceptor",
"destination": {
"timeout_ms": 5000,
"url": "https://psp.example.com/payments"
},
"field_mapping": [
{}
],
"responses": {}
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload = {
"active": True,
"context": "checkout",
"description": "Checkout flow interceptor",
"destination": {
"timeout_ms": 5000,
"url": "https://psp.example.com/payments"
},
"field_mapping": [{}],
"responses": {}
}
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({
active: true,
context: 'checkout',
description: 'Checkout flow interceptor',
destination: {timeout_ms: 5000, url: 'https://psp.example.com/payments'},
field_mapping: [{}],
responses: {}
})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{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([
'active' => true,
'context' => 'checkout',
'description' => 'Checkout flow interceptor',
'destination' => [
'timeout_ms' => 5000,
'url' => 'https://psp.example.com/payments'
],
'field_mapping' => [
[
]
],
'responses' => [
]
]),
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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload := strings.NewReader("{\n \"active\": true,\n \"context\": \"checkout\",\n \"description\": \"Checkout flow interceptor\",\n \"destination\": {\n \"timeout_ms\": 5000,\n \"url\": \"https://psp.example.com/payments\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"context\": \"checkout\",\n \"description\": \"Checkout flow interceptor\",\n \"destination\": {\n \"timeout_ms\": 5000,\n \"url\": \"https://psp.example.com/payments\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{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 \"active\": true,\n \"context\": \"checkout\",\n \"description\": \"Checkout flow interceptor\",\n \"destination\": {\n \"timeout_ms\": 5000,\n \"url\": \"https://psp.example.com/payments\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "5c9e1b3d-8f4a-4b6c-9d2e-7a5f3c1e8b4d",
"context": "checkout",
"description": "Checkout flow interceptor",
"destination": {
"timeout_ms": 30000,
"url": "https://checkout.example.com/payments"
},
"discovered_keys": [
{
"key": "$.device.ip",
"type": "string"
}
],
"field_mapping": [
{}
],
"inserted_at": "2026-03-01T09:00:00Z",
"ref": "checkout-interceptor",
"responses": null,
"updated_at": "2026-03-01T09:00:00Z",
"version": 3
}{
"classifier": "UNAUTHORIZED",
"code": 401,
"message": "No valid means of authentication was provided"
}{
"classifier": "FORBIDDEN",
"code": 403,
"message": "Not allowed to access this resource or feature"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "must be a positive integer",
"path": "limit"
}
]
}