Create a composition delivery
curl --request POST \
--url https://api.tightknit.ai/v1/composition_deliveries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"composition_id": "cmps_7h2k9m4n1p6q",
"identity": "bot",
"unfurl_links": true,
"channel_ids": [
"<string>"
],
"publish_to_site": true,
"thread_ts": "<string>",
"member_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"feed_ids": [
"<string>"
],
"event_ids": [
"<string>"
],
"expected_revision": 1
}
'import requests
url = "https://api.tightknit.ai/v1/composition_deliveries"
payload = {
"composition_id": "cmps_7h2k9m4n1p6q",
"identity": "bot",
"unfurl_links": True,
"channel_ids": ["<string>"],
"publish_to_site": True,
"thread_ts": "<string>",
"member_ids": ["<string>"],
"group_ids": ["<string>"],
"feed_ids": ["<string>"],
"event_ids": ["<string>"],
"expected_revision": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
composition_id: 'cmps_7h2k9m4n1p6q',
identity: 'bot',
unfurl_links: true,
channel_ids: ['<string>'],
publish_to_site: true,
thread_ts: '<string>',
member_ids: ['<string>'],
group_ids: ['<string>'],
feed_ids: ['<string>'],
event_ids: ['<string>'],
expected_revision: 1
})
};
fetch('https://api.tightknit.ai/v1/composition_deliveries', 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",
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([
'composition_id' => 'cmps_7h2k9m4n1p6q',
'identity' => 'bot',
'unfurl_links' => true,
'channel_ids' => [
'<string>'
],
'publish_to_site' => true,
'thread_ts' => '<string>',
'member_ids' => [
'<string>'
],
'group_ids' => [
'<string>'
],
'feed_ids' => [
'<string>'
],
'event_ids' => [
'<string>'
],
'expected_revision' => 1
]),
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.tightknit.ai/v1/composition_deliveries"
payload := strings.NewReader("{\n \"composition_id\": \"cmps_7h2k9m4n1p6q\",\n \"identity\": \"bot\",\n \"unfurl_links\": true,\n \"channel_ids\": [\n \"<string>\"\n ],\n \"publish_to_site\": true,\n \"thread_ts\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"group_ids\": [\n \"<string>\"\n ],\n \"feed_ids\": [\n \"<string>\"\n ],\n \"event_ids\": [\n \"<string>\"\n ],\n \"expected_revision\": 1\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.tightknit.ai/v1/composition_deliveries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"composition_id\": \"cmps_7h2k9m4n1p6q\",\n \"identity\": \"bot\",\n \"unfurl_links\": true,\n \"channel_ids\": [\n \"<string>\"\n ],\n \"publish_to_site\": true,\n \"thread_ts\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"group_ids\": [\n \"<string>\"\n ],\n \"feed_ids\": [\n \"<string>\"\n ],\n \"event_ids\": [\n \"<string>\"\n ],\n \"expected_revision\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/composition_deliveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"composition_id\": \"cmps_7h2k9m4n1p6q\",\n \"identity\": \"bot\",\n \"unfurl_links\": true,\n \"channel_ids\": [\n \"<string>\"\n ],\n \"publish_to_site\": true,\n \"thread_ts\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"group_ids\": [\n \"<string>\"\n ],\n \"feed_ids\": [\n \"<string>\"\n ],\n \"event_ids\": [\n \"<string>\"\n ],\n \"expected_revision\": 1\n}"
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
Create a composition delivery
Adds a destination to where a composition will go. It never sends: deliver on the composition sends to every destination it has. The destination is checked as a send would be, so a channel the Tightknit app cannot post in, or a workspace without the app, is refused now with a 400. An API key sends from the bot or the community, never as a member. Needs the editor role. Refused with a 400 on a composition that is scheduled, whose schedule sets where it goes, or already sent, and on one that already has 10 destinations; a stale expected_revision is a 409.
Create a composition delivery
curl --request POST \
--url https://api.tightknit.ai/v1/composition_deliveries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"composition_id": "cmps_7h2k9m4n1p6q",
"identity": "bot",
"unfurl_links": true,
"channel_ids": [
"<string>"
],
"publish_to_site": true,
"thread_ts": "<string>",
"member_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"feed_ids": [
"<string>"
],
"event_ids": [
"<string>"
],
"expected_revision": 1
}
'import requests
url = "https://api.tightknit.ai/v1/composition_deliveries"
payload = {
"composition_id": "cmps_7h2k9m4n1p6q",
"identity": "bot",
"unfurl_links": True,
"channel_ids": ["<string>"],
"publish_to_site": True,
"thread_ts": "<string>",
"member_ids": ["<string>"],
"group_ids": ["<string>"],
"feed_ids": ["<string>"],
"event_ids": ["<string>"],
"expected_revision": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
composition_id: 'cmps_7h2k9m4n1p6q',
identity: 'bot',
unfurl_links: true,
channel_ids: ['<string>'],
publish_to_site: true,
thread_ts: '<string>',
member_ids: ['<string>'],
group_ids: ['<string>'],
feed_ids: ['<string>'],
event_ids: ['<string>'],
expected_revision: 1
})
};
fetch('https://api.tightknit.ai/v1/composition_deliveries', 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",
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([
'composition_id' => 'cmps_7h2k9m4n1p6q',
'identity' => 'bot',
'unfurl_links' => true,
'channel_ids' => [
'<string>'
],
'publish_to_site' => true,
'thread_ts' => '<string>',
'member_ids' => [
'<string>'
],
'group_ids' => [
'<string>'
],
'feed_ids' => [
'<string>'
],
'event_ids' => [
'<string>'
],
'expected_revision' => 1
]),
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.tightknit.ai/v1/composition_deliveries"
payload := strings.NewReader("{\n \"composition_id\": \"cmps_7h2k9m4n1p6q\",\n \"identity\": \"bot\",\n \"unfurl_links\": true,\n \"channel_ids\": [\n \"<string>\"\n ],\n \"publish_to_site\": true,\n \"thread_ts\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"group_ids\": [\n \"<string>\"\n ],\n \"feed_ids\": [\n \"<string>\"\n ],\n \"event_ids\": [\n \"<string>\"\n ],\n \"expected_revision\": 1\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.tightknit.ai/v1/composition_deliveries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"composition_id\": \"cmps_7h2k9m4n1p6q\",\n \"identity\": \"bot\",\n \"unfurl_links\": true,\n \"channel_ids\": [\n \"<string>\"\n ],\n \"publish_to_site\": true,\n \"thread_ts\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"group_ids\": [\n \"<string>\"\n ],\n \"feed_ids\": [\n \"<string>\"\n ],\n \"event_ids\": [\n \"<string>\"\n ],\n \"expected_revision\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tightknit.ai/v1/composition_deliveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"composition_id\": \"cmps_7h2k9m4n1p6q\",\n \"identity\": \"bot\",\n \"unfurl_links\": true,\n \"channel_ids\": [\n \"<string>\"\n ],\n \"publish_to_site\": true,\n \"thread_ts\": \"<string>\",\n \"member_ids\": [\n \"<string>\"\n ],\n \"group_ids\": [\n \"<string>\"\n ],\n \"feed_ids\": [\n \"<string>\"\n ],\n \"event_ids\": [\n \"<string>\"\n ],\n \"expected_revision\": 1\n}"
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>.
Body
application/json
The id of the composition to set the destination on.
Example:
"cmps_7h2k9m4n1p6q"
Where it goes. One of:
slack_channel: a post in each ofchannel_ids.slack_dm: a direct message to each member named bymember_ids,group_ids,feed_idsorevent_ids, once each.
Available options:
slack_channel, slack_dm Who it sends as. One of:
bot: the Tightknit app, the default.community: the app under the community name and logo, forslack_channelonly.
Available options:
bot, community Whether Slack previews the message’s links. Left to Slack when omitted.
The Slack channels to post in, required for slack_channel. The Tightknit app must be able to post in each.
Required array length:
1 - 50 elementsPattern:
^[CG][A-Z0-9]{8,20}$For slack_channel: also publish each post to its channel's feed on the community site.
For slack_channel with one channel: reply in this message's thread.
Pattern:
^\d{10}\.\d{6}$For slack_dm: the ids of the profiles to message.
Maximum array length:
1000Pattern:
^prof_[a-zA-Z0-9]{12}$For slack_dm: the ids of the groups whose members to message.
Maximum array length:
50Pattern:
^grup_[a-zA-Z0-9]{12}$For slack_dm: the ids of the feeds whose members to message.
Maximum array length:
50Pattern:
^feed_[a-zA-Z0-9]{12}$For slack_dm: the ids of the events whose registrants to message.
Maximum array length:
50Pattern:
^cevt_[a-zA-Z0-9]{12}$The revision you last read. A composition changed since is refused with a 409 rather than overwritten. Omit to change whatever is stored.
Required range:
x >= 0Response
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?