Update Pipeline Notification Settings
curl --request PATCH \
--url https://api.example.com/pipelines/{pipeline_id}/notification-settings/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"notification_settings": [
{
"method": "EMAIL",
"user_ids": [
"<string>"
],
"member_ids": [
"<string>"
]
}
]
}
'import requests
url = "https://api.example.com/pipelines/{pipeline_id}/notification-settings/"
payload = { "notification_settings": [
{
"method": "EMAIL",
"user_ids": ["<string>"],
"member_ids": ["<string>"]
}
] }
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({
notification_settings: [{method: 'EMAIL', user_ids: ['<string>'], member_ids: ['<string>']}]
})
};
fetch('https://api.example.com/pipelines/{pipeline_id}/notification-settings/', 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.example.com/pipelines/{pipeline_id}/notification-settings/",
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([
'notification_settings' => [
[
'method' => 'EMAIL',
'user_ids' => [
'<string>'
],
'member_ids' => [
'<string>'
]
]
]
]),
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.example.com/pipelines/{pipeline_id}/notification-settings/"
payload := strings.NewReader("{\n \"notification_settings\": [\n {\n \"method\": \"EMAIL\",\n \"user_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"<string>\"\n ]\n }\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.example.com/pipelines/{pipeline_id}/notification-settings/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notification_settings\": [\n {\n \"method\": \"EMAIL\",\n \"user_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/pipelines/{pipeline_id}/notification-settings/")
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 \"notification_settings\": [\n {\n \"method\": \"EMAIL\",\n \"user_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"cron_schedule": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notification_settings": [
{
"method": "EMAIL",
"user_ids": [
"<string>"
],
"member_ids": [
"<string>"
]
}
],
"lower_env_pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"higher_env_pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"steps": [
{
"name": "<string>",
"config": {
"query_type": "sql",
"query": "<string>",
"input_datasets": [
"<string>"
],
"output_datasets": [
"<string>"
],
"job_type": "data-transform"
},
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"release": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
},
"annotations": {
"changed": [
{
"step_name": "<string>",
"change_status": "added",
"before": "<string>",
"after": "<string>"
}
],
"canvas_node_annotations": {},
"dataset_output_folders": {}
},
"change_description": "<string>",
"checkpoint": {
"pipeline_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"reference_notes": "<string>",
"schedule_enabled": true,
"latest_run_status": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}pipelines
Update Pipeline Notification Settings
PATCH
/
pipelines
/
{pipeline_id}
/
notification-settings
/
Update Pipeline Notification Settings
curl --request PATCH \
--url https://api.example.com/pipelines/{pipeline_id}/notification-settings/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"notification_settings": [
{
"method": "EMAIL",
"user_ids": [
"<string>"
],
"member_ids": [
"<string>"
]
}
]
}
'import requests
url = "https://api.example.com/pipelines/{pipeline_id}/notification-settings/"
payload = { "notification_settings": [
{
"method": "EMAIL",
"user_ids": ["<string>"],
"member_ids": ["<string>"]
}
] }
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({
notification_settings: [{method: 'EMAIL', user_ids: ['<string>'], member_ids: ['<string>']}]
})
};
fetch('https://api.example.com/pipelines/{pipeline_id}/notification-settings/', 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.example.com/pipelines/{pipeline_id}/notification-settings/",
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([
'notification_settings' => [
[
'method' => 'EMAIL',
'user_ids' => [
'<string>'
],
'member_ids' => [
'<string>'
]
]
]
]),
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.example.com/pipelines/{pipeline_id}/notification-settings/"
payload := strings.NewReader("{\n \"notification_settings\": [\n {\n \"method\": \"EMAIL\",\n \"user_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"<string>\"\n ]\n }\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.example.com/pipelines/{pipeline_id}/notification-settings/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notification_settings\": [\n {\n \"method\": \"EMAIL\",\n \"user_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/pipelines/{pipeline_id}/notification-settings/")
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 \"notification_settings\": [\n {\n \"method\": \"EMAIL\",\n \"user_ids\": [\n \"<string>\"\n ],\n \"member_ids\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"cron_schedule": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notification_settings": [
{
"method": "EMAIL",
"user_ids": [
"<string>"
],
"member_ids": [
"<string>"
]
}
],
"lower_env_pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"higher_env_pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"steps": [
{
"name": "<string>",
"config": {
"query_type": "sql",
"query": "<string>",
"input_datasets": [
"<string>"
],
"output_datasets": [
"<string>"
],
"job_type": "data-transform"
},
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"release": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
},
"annotations": {
"changed": [
{
"step_name": "<string>",
"change_status": "added",
"before": "<string>",
"after": "<string>"
}
],
"canvas_node_annotations": {},
"dataset_output_folders": {}
},
"change_description": "<string>",
"checkpoint": {
"pipeline_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
},
"reference_notes": "<string>",
"schedule_enabled": true,
"latest_run_status": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
application/json
- EmailNotification
- SlackNotification
Show child attributes
Show child attributes
Response
Successful Response
- EmailNotification
- SlackNotification
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Latest run status for the pipeline's current version (list endpoint; detail uses pipeline_runs).