Preview an endpoint update
curl --request POST \
--url https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"params": {}
}'import requests
url = "https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}"
payload = { "params": {} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({params: {}})
};
fetch('https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}', 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.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'params' => [
]
]),
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.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}"
payload := strings.NewReader("{\n \"params\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"params\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"params\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {},
"sample_inputs": {}
}Dispatch
Preview an endpoint update
Test an endpoint against the canonical version to see the updated behavior before merging. Returns the execution result plus sample inputs.
POST
/
dispatch
/
tasks
/
{task_id}
/
preview-update
/
{endpoint_name}
Preview an endpoint update
curl --request POST \
--url https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"params": {}
}'import requests
url = "https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}"
payload = { "params": {} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({params: {}})
};
fetch('https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}', 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.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'params' => [
]
]),
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.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}"
payload := strings.NewReader("{\n \"params\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"params\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parse.bot/dispatch/tasks/{task_id}/preview-update/{endpoint_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"params\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {},
"sample_inputs": {}
}Authorizations
API key for programmatic access. Create one in the Parse dashboard at https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.
Body
application/json
Test parameters for the endpoint
Was this page helpful?
⌘I