Retrieve a composition delivery
curl --request GET \
--url https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_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.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "composition_delivery",
"id": "cpdl_4k8m2n6p9q3r",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"composition_id": "cmps_7h2k9m4n1p6q",
"composition_version_id": "<string>",
"destination": "slack_channel",
"status": "pending",
"identity": "user",
"unfurl_links": true,
"slack_channel": {
"channel_ids": [
"<string>"
],
"publish_to_site": true,
"thread_ts": "<string>"
},
"slack_dm": {
"member_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"feed_ids": [
"<string>"
],
"event_ids": [
"<string>"
]
},
"counts": {
"pending": 1,
"claimed": 1,
"sent": 1,
"failed": 1,
"skipped": 1
},
"error_code": "<string>",
"delivered_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"created_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
},
"updated_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
}
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "<string>",
"param": "<string>",
"request_id": "req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e"
}Compositions
Retrieve a composition delivery
Returns one composition delivery by its id.
Retrieve a composition delivery
curl --request GET \
--url https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_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.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/composition_deliveries/{composition_delivery_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "composition_delivery",
"id": "cpdl_4k8m2n6p9q3r",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"composition_id": "cmps_7h2k9m4n1p6q",
"composition_version_id": "<string>",
"destination": "slack_channel",
"status": "pending",
"identity": "user",
"unfurl_links": true,
"slack_channel": {
"channel_ids": [
"<string>"
],
"publish_to_site": true,
"thread_ts": "<string>"
},
"slack_dm": {
"member_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"feed_ids": [
"<string>"
],
"event_ids": [
"<string>"
]
},
"counts": {
"pending": 1,
"claimed": 1,
"sent": 1,
"failed": 1,
"skipped": 1
},
"error_code": "<string>",
"delivered_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"created_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
},
"updated_by": {
"object": "profile",
"id": "prof_9f2b8c1d4e5a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "Ada Lovelace",
"full_name": "Ada Lovelace",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"email": "[email protected]",
"email_domain": "example.com",
"locale": "<string>",
"is_team_member": true,
"is_deactivated": true,
"opt_out_of_public_profile": true,
"member_since": "2023-11-07T05:31:56Z",
"invited_at": "2023-11-07T05:31:56Z",
"signed_up_at": "2023-11-07T05:31:56Z",
"source": "slack_sync",
"has_account": true,
"flair_group_id": "grup_7m3x9k4t8plz",
"slack_profile_id": "U0BRY4S6LNQ",
"integrations": {
"slack": {
"profile": {
"object": "slack_profile",
"id": "U0BRY4S6LNQ",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"workspace_id": "T01ABC123",
"display_name": "<string>",
"real_name": "<string>",
"email": "[email protected]",
"pronouns": "<string>",
"avatar_url": "<string>",
"locale": "<string>",
"tz": "<string>",
"is_bot": true,
"is_app_user": true,
"is_workflow_bot": true,
"is_admin": true,
"is_owner": true,
"is_restricted": true,
"is_invited_user": true,
"is_deleted": true
}
}
}
}
}{
"type": "about:blank",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "<string>",
"param": "<string>",
"request_id": "req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e"
}Authorizations
A Tightknit admin API key, sent as Authorization: Bearer <key>.
Path Parameters
The composition delivery's id.
Pattern:
^cpdl_[a-zA-Z0-9]{12}$Query Parameters
Repeatable. Returns the named relation inline. One of: created_by, updated_by.
Available options:
created_by, updated_by Response
Success
Always composition_delivery.
Available options:
composition_delivery Unique identifier for the object.
Example:
"cpdl_4k8m2n6p9q3r"
When the object was created.
When the object was last changed.
The id of the composition this delivery sends.
Example:
"cmps_7h2k9m4n1p6q"
The id of the composition version this delivery sent. Null until the composition is sent, while it is only where the composition is set to go.
Where it goes. One of:
slack_channel: a post in each ofslack_channel.channel_ids.slack_dm: a direct message to each memberslack_dmnames, directly or through a group, feed or event.
Available options:
slack_channel, slack_dm How the delivery stands. One of:
pending: set up, and not sent yet; or sent and waiting to start.scheduled: set to go out at the composition’sscheduled_at.delivering: sending now.delivered: reached every recipient it could.partially_delivered: reached some recipients, and some failed.failed: reached nobody, because every recipient failed or the delivery could not start.canceled: called off before it was sent.
Available options:
pending, scheduled, delivering, delivered, partially_delivered, failed, canceled Who it sends as. One of:
bot: the Tightknit app.community: the app under the community name and logo; channel posts only.user: the Studio user who sent it, from their own Slack account. An API key cannot send as one.
Null when its settings cannot be read.
Available options:
user, bot, community Whether Slack previews the message’s links. Null when left to Slack.
Where it posts. Null unless destination is slack_channel.
Show child attributes
Show child attributes
Who it messages. Null unless destination is slack_dm.
Show child attributes
Show child attributes
Its recipients by how their send stands, as last rolled up. Empty until the delivery starts; a status with none is absent.
Show child attributes
Show child attributes
Why it failed as a whole, or the reason every recipient that failed shares, such as outcome_unknown when Slack could not say whether a message landed. Null otherwise.
When it finished sending. Null until then.
The id of the profile that set it up or sent it. Null when an API key did, or once that profile is deleted.
The id of the profile that last changed it. Null when an API key or the send itself did, or once that profile is deleted.
The profile that set it up or sent it. Present only when created_by is expanded.
Show child attributes
Show child attributes
The profile that last changed it. Present only when updated_by is expanded.
Show child attributes
Show child attributes
Was this page helpful?