Create an app
curl --request POST \
--url https://api-dev.narrative.io/v2/apps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "facebook_connector",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": [
"<string>"
],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": true,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"tags": [
"<string>"
]
}
},
"api_key": "connector-api-key"
}
'import requests
url = "https://api-dev.narrative.io/v2/apps"
payload = {
"slug": "facebook_connector",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": ["<string>"],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": True,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"tags": ["<string>"]
}
},
"api_key": "connector-api-key"
}
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({
slug: 'facebook_connector',
manifest: {
manifest_version: '1.0.0',
display_name: 'Facebook Connector',
capabilities: [],
api_url: 'https://facebook-connector.example.com/api',
required_scopes: [{resource: 'datasets', access: 'read'}],
app_token_scopes: [{resource: 'datasets', access: 'read'}],
ui_url: 'https://facebook-connector.example.com',
launch_path: {type: 'native', path: 'connector-settings'},
embedding: {device_permissions: ['<string>'], initial_guest_path: '/'},
pages: [
{
eligible_path: 'connector-settings',
navigation: {
title: 'Connector Settings',
icon: 'display-list',
pill: '<string>',
show_as_button: true,
button_variant: '<string>'
},
visible_path: '<string>'
}
],
listing: {
short_description: '<string>',
long_description: '<string>',
meta_description: '<string>',
background_color: '#E7E3CE',
merchandising_sections: [
{
title: '<string>',
subtitle: '<string>',
order: 123,
image: {
name: '<string>',
image: '<string>',
image_type: 'image/svg+xml',
alt_text: '<string>',
width: 123,
height: 123
}
}
],
tags: ['<string>']
}
},
api_key: 'connector-api-key'
})
};
fetch('https://api-dev.narrative.io/v2/apps', 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-dev.narrative.io/v2/apps",
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([
'slug' => 'facebook_connector',
'manifest' => [
'manifest_version' => '1.0.0',
'display_name' => 'Facebook Connector',
'capabilities' => [
],
'api_url' => 'https://facebook-connector.example.com/api',
'required_scopes' => [
[
'resource' => 'datasets',
'access' => 'read'
]
],
'app_token_scopes' => [
[
'resource' => 'datasets',
'access' => 'read'
]
],
'ui_url' => 'https://facebook-connector.example.com',
'launch_path' => [
'type' => 'native',
'path' => 'connector-settings'
],
'embedding' => [
'device_permissions' => [
'<string>'
],
'initial_guest_path' => '/'
],
'pages' => [
[
'eligible_path' => 'connector-settings',
'navigation' => [
'title' => 'Connector Settings',
'icon' => 'display-list',
'pill' => '<string>',
'show_as_button' => true,
'button_variant' => '<string>'
],
'visible_path' => '<string>'
]
],
'listing' => [
'short_description' => '<string>',
'long_description' => '<string>',
'meta_description' => '<string>',
'background_color' => '#E7E3CE',
'merchandising_sections' => [
[
'title' => '<string>',
'subtitle' => '<string>',
'order' => 123,
'image' => [
'name' => '<string>',
'image' => '<string>',
'image_type' => 'image/svg+xml',
'alt_text' => '<string>',
'width' => 123,
'height' => 123
]
]
],
'tags' => [
'<string>'
]
]
],
'api_key' => 'connector-api-key'
]),
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-dev.narrative.io/v2/apps"
payload := strings.NewReader("{\n \"slug\": \"facebook_connector\",\n \"manifest\": {\n \"manifest_version\": \"1.0.0\",\n \"display_name\": \"Facebook Connector\",\n \"capabilities\": [],\n \"api_url\": \"https://facebook-connector.example.com/api\",\n \"required_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"app_token_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"ui_url\": \"https://facebook-connector.example.com\",\n \"launch_path\": {\n \"type\": \"native\",\n \"path\": \"connector-settings\"\n },\n \"embedding\": {\n \"device_permissions\": [\n \"<string>\"\n ],\n \"initial_guest_path\": \"/\"\n },\n \"pages\": [\n {\n \"eligible_path\": \"connector-settings\",\n \"navigation\": {\n \"title\": \"Connector Settings\",\n \"icon\": \"display-list\",\n \"pill\": \"<string>\",\n \"show_as_button\": true,\n \"button_variant\": \"<string>\"\n },\n \"visible_path\": \"<string>\"\n }\n ],\n \"listing\": {\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"background_color\": \"#E7E3CE\",\n \"merchandising_sections\": [\n {\n \"title\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"order\": 123,\n \"image\": {\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"image_type\": \"image/svg+xml\",\n \"alt_text\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n }\n ],\n \"tags\": [\n \"<string>\"\n ]\n }\n },\n \"api_key\": \"connector-api-key\"\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-dev.narrative.io/v2/apps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"facebook_connector\",\n \"manifest\": {\n \"manifest_version\": \"1.0.0\",\n \"display_name\": \"Facebook Connector\",\n \"capabilities\": [],\n \"api_url\": \"https://facebook-connector.example.com/api\",\n \"required_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"app_token_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"ui_url\": \"https://facebook-connector.example.com\",\n \"launch_path\": {\n \"type\": \"native\",\n \"path\": \"connector-settings\"\n },\n \"embedding\": {\n \"device_permissions\": [\n \"<string>\"\n ],\n \"initial_guest_path\": \"/\"\n },\n \"pages\": [\n {\n \"eligible_path\": \"connector-settings\",\n \"navigation\": {\n \"title\": \"Connector Settings\",\n \"icon\": \"display-list\",\n \"pill\": \"<string>\",\n \"show_as_button\": true,\n \"button_variant\": \"<string>\"\n },\n \"visible_path\": \"<string>\"\n }\n ],\n \"listing\": {\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"background_color\": \"#E7E3CE\",\n \"merchandising_sections\": [\n {\n \"title\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"order\": 123,\n \"image\": {\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"image_type\": \"image/svg+xml\",\n \"alt_text\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n }\n ],\n \"tags\": [\n \"<string>\"\n ]\n }\n },\n \"api_key\": \"connector-api-key\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/v2/apps")
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 \"slug\": \"facebook_connector\",\n \"manifest\": {\n \"manifest_version\": \"1.0.0\",\n \"display_name\": \"Facebook Connector\",\n \"capabilities\": [],\n \"api_url\": \"https://facebook-connector.example.com/api\",\n \"required_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"app_token_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"ui_url\": \"https://facebook-connector.example.com\",\n \"launch_path\": {\n \"type\": \"native\",\n \"path\": \"connector-settings\"\n },\n \"embedding\": {\n \"device_permissions\": [\n \"<string>\"\n ],\n \"initial_guest_path\": \"/\"\n },\n \"pages\": [\n {\n \"eligible_path\": \"connector-settings\",\n \"navigation\": {\n \"title\": \"Connector Settings\",\n \"icon\": \"display-list\",\n \"pill\": \"<string>\",\n \"show_as_button\": true,\n \"button_variant\": \"<string>\"\n },\n \"visible_path\": \"<string>\"\n }\n ],\n \"listing\": {\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"background_color\": \"#E7E3CE\",\n \"merchandising_sections\": [\n {\n \"title\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"order\": 123,\n \"image\": {\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"image_type\": \"image/svg+xml\",\n \"alt_text\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n }\n ],\n \"tags\": [\n \"<string>\"\n ]\n }\n },\n \"api_key\": \"connector-api-key\"\n}"
response = http.request(request)
puts response.read_body{
"type": "owned",
"id": 42,
"slug": "facebook_connector",
"status": "pending",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [
"destination_connector"
],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": [
"<string>"
],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": true,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"headlines": {
"tagline": "<string>",
"body": "<string>"
},
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"icon": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"headline_image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"developer_information": {
"name": "<string>",
"website": "<string>",
"support_email": "<string>",
"privacy_policy": "<string>",
"support_website": "<string>"
},
"tags": [
"<string>"
]
}
},
"client_id": "85b558340b635861575c462a10df3bd5",
"created_at": "2026-09-24T17:21:03.120581",
"updated_at": "2026-09-24T17:21:03.120581"
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}Apps
Create an app
Registers an app owned by the caller’s company. The app starts pending: only the owning company can see and
install it.
The app is created with client credentials, but the secret is not returned. Call
POST /v2/apps/{app_slug}/credentials/generate to obtain one.
Requires a token with write access to apps, such as a system access token created with that permission.
POST
/
v2
/
apps
Create an app
curl --request POST \
--url https://api-dev.narrative.io/v2/apps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "facebook_connector",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": [
"<string>"
],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": true,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"tags": [
"<string>"
]
}
},
"api_key": "connector-api-key"
}
'import requests
url = "https://api-dev.narrative.io/v2/apps"
payload = {
"slug": "facebook_connector",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": ["<string>"],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": True,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"tags": ["<string>"]
}
},
"api_key": "connector-api-key"
}
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({
slug: 'facebook_connector',
manifest: {
manifest_version: '1.0.0',
display_name: 'Facebook Connector',
capabilities: [],
api_url: 'https://facebook-connector.example.com/api',
required_scopes: [{resource: 'datasets', access: 'read'}],
app_token_scopes: [{resource: 'datasets', access: 'read'}],
ui_url: 'https://facebook-connector.example.com',
launch_path: {type: 'native', path: 'connector-settings'},
embedding: {device_permissions: ['<string>'], initial_guest_path: '/'},
pages: [
{
eligible_path: 'connector-settings',
navigation: {
title: 'Connector Settings',
icon: 'display-list',
pill: '<string>',
show_as_button: true,
button_variant: '<string>'
},
visible_path: '<string>'
}
],
listing: {
short_description: '<string>',
long_description: '<string>',
meta_description: '<string>',
background_color: '#E7E3CE',
merchandising_sections: [
{
title: '<string>',
subtitle: '<string>',
order: 123,
image: {
name: '<string>',
image: '<string>',
image_type: 'image/svg+xml',
alt_text: '<string>',
width: 123,
height: 123
}
}
],
tags: ['<string>']
}
},
api_key: 'connector-api-key'
})
};
fetch('https://api-dev.narrative.io/v2/apps', 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-dev.narrative.io/v2/apps",
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([
'slug' => 'facebook_connector',
'manifest' => [
'manifest_version' => '1.0.0',
'display_name' => 'Facebook Connector',
'capabilities' => [
],
'api_url' => 'https://facebook-connector.example.com/api',
'required_scopes' => [
[
'resource' => 'datasets',
'access' => 'read'
]
],
'app_token_scopes' => [
[
'resource' => 'datasets',
'access' => 'read'
]
],
'ui_url' => 'https://facebook-connector.example.com',
'launch_path' => [
'type' => 'native',
'path' => 'connector-settings'
],
'embedding' => [
'device_permissions' => [
'<string>'
],
'initial_guest_path' => '/'
],
'pages' => [
[
'eligible_path' => 'connector-settings',
'navigation' => [
'title' => 'Connector Settings',
'icon' => 'display-list',
'pill' => '<string>',
'show_as_button' => true,
'button_variant' => '<string>'
],
'visible_path' => '<string>'
]
],
'listing' => [
'short_description' => '<string>',
'long_description' => '<string>',
'meta_description' => '<string>',
'background_color' => '#E7E3CE',
'merchandising_sections' => [
[
'title' => '<string>',
'subtitle' => '<string>',
'order' => 123,
'image' => [
'name' => '<string>',
'image' => '<string>',
'image_type' => 'image/svg+xml',
'alt_text' => '<string>',
'width' => 123,
'height' => 123
]
]
],
'tags' => [
'<string>'
]
]
],
'api_key' => 'connector-api-key'
]),
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-dev.narrative.io/v2/apps"
payload := strings.NewReader("{\n \"slug\": \"facebook_connector\",\n \"manifest\": {\n \"manifest_version\": \"1.0.0\",\n \"display_name\": \"Facebook Connector\",\n \"capabilities\": [],\n \"api_url\": \"https://facebook-connector.example.com/api\",\n \"required_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"app_token_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"ui_url\": \"https://facebook-connector.example.com\",\n \"launch_path\": {\n \"type\": \"native\",\n \"path\": \"connector-settings\"\n },\n \"embedding\": {\n \"device_permissions\": [\n \"<string>\"\n ],\n \"initial_guest_path\": \"/\"\n },\n \"pages\": [\n {\n \"eligible_path\": \"connector-settings\",\n \"navigation\": {\n \"title\": \"Connector Settings\",\n \"icon\": \"display-list\",\n \"pill\": \"<string>\",\n \"show_as_button\": true,\n \"button_variant\": \"<string>\"\n },\n \"visible_path\": \"<string>\"\n }\n ],\n \"listing\": {\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"background_color\": \"#E7E3CE\",\n \"merchandising_sections\": [\n {\n \"title\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"order\": 123,\n \"image\": {\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"image_type\": \"image/svg+xml\",\n \"alt_text\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n }\n ],\n \"tags\": [\n \"<string>\"\n ]\n }\n },\n \"api_key\": \"connector-api-key\"\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-dev.narrative.io/v2/apps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"facebook_connector\",\n \"manifest\": {\n \"manifest_version\": \"1.0.0\",\n \"display_name\": \"Facebook Connector\",\n \"capabilities\": [],\n \"api_url\": \"https://facebook-connector.example.com/api\",\n \"required_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"app_token_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"ui_url\": \"https://facebook-connector.example.com\",\n \"launch_path\": {\n \"type\": \"native\",\n \"path\": \"connector-settings\"\n },\n \"embedding\": {\n \"device_permissions\": [\n \"<string>\"\n ],\n \"initial_guest_path\": \"/\"\n },\n \"pages\": [\n {\n \"eligible_path\": \"connector-settings\",\n \"navigation\": {\n \"title\": \"Connector Settings\",\n \"icon\": \"display-list\",\n \"pill\": \"<string>\",\n \"show_as_button\": true,\n \"button_variant\": \"<string>\"\n },\n \"visible_path\": \"<string>\"\n }\n ],\n \"listing\": {\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"background_color\": \"#E7E3CE\",\n \"merchandising_sections\": [\n {\n \"title\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"order\": 123,\n \"image\": {\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"image_type\": \"image/svg+xml\",\n \"alt_text\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n }\n ],\n \"tags\": [\n \"<string>\"\n ]\n }\n },\n \"api_key\": \"connector-api-key\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/v2/apps")
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 \"slug\": \"facebook_connector\",\n \"manifest\": {\n \"manifest_version\": \"1.0.0\",\n \"display_name\": \"Facebook Connector\",\n \"capabilities\": [],\n \"api_url\": \"https://facebook-connector.example.com/api\",\n \"required_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"app_token_scopes\": [\n {\n \"resource\": \"datasets\",\n \"access\": \"read\"\n }\n ],\n \"ui_url\": \"https://facebook-connector.example.com\",\n \"launch_path\": {\n \"type\": \"native\",\n \"path\": \"connector-settings\"\n },\n \"embedding\": {\n \"device_permissions\": [\n \"<string>\"\n ],\n \"initial_guest_path\": \"/\"\n },\n \"pages\": [\n {\n \"eligible_path\": \"connector-settings\",\n \"navigation\": {\n \"title\": \"Connector Settings\",\n \"icon\": \"display-list\",\n \"pill\": \"<string>\",\n \"show_as_button\": true,\n \"button_variant\": \"<string>\"\n },\n \"visible_path\": \"<string>\"\n }\n ],\n \"listing\": {\n \"short_description\": \"<string>\",\n \"long_description\": \"<string>\",\n \"meta_description\": \"<string>\",\n \"background_color\": \"#E7E3CE\",\n \"merchandising_sections\": [\n {\n \"title\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"order\": 123,\n \"image\": {\n \"name\": \"<string>\",\n \"image\": \"<string>\",\n \"image_type\": \"image/svg+xml\",\n \"alt_text\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n }\n ],\n \"tags\": [\n \"<string>\"\n ]\n }\n },\n \"api_key\": \"connector-api-key\"\n}"
response = http.request(request)
puts response.read_body{
"type": "owned",
"id": 42,
"slug": "facebook_connector",
"status": "pending",
"manifest": {
"manifest_version": "1.0.0",
"display_name": "Facebook Connector",
"capabilities": [
"destination_connector"
],
"api_url": "https://facebook-connector.example.com/api",
"required_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"app_token_scopes": [
{
"resource": "datasets",
"access": "read"
}
],
"ui_url": "https://facebook-connector.example.com",
"launch_path": {
"type": "native",
"path": "connector-settings"
},
"embedding": {
"device_permissions": [
"<string>"
],
"initial_guest_path": "/"
},
"pages": [
{
"eligible_path": "connector-settings",
"navigation": {
"title": "Connector Settings",
"icon": "display-list",
"pill": "<string>",
"show_as_button": true,
"button_variant": "<string>"
},
"visible_path": "<string>"
}
],
"listing": {
"headlines": {
"tagline": "<string>",
"body": "<string>"
},
"short_description": "<string>",
"long_description": "<string>",
"meta_description": "<string>",
"icon": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"headline_image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
},
"background_color": "#E7E3CE",
"merchandising_sections": [
{
"title": "<string>",
"subtitle": "<string>",
"order": 123,
"image": {
"name": "<string>",
"image": "<string>",
"image_type": "image/svg+xml",
"alt_text": "<string>",
"width": 123,
"height": 123
}
}
],
"developer_information": {
"name": "<string>",
"website": "<string>",
"support_email": "<string>",
"privacy_policy": "<string>",
"support_website": "<string>"
},
"tags": [
"<string>"
]
}
},
"client_id": "85b558340b635861575c462a10df3bd5",
"created_at": "2026-09-24T17:21:03.120581",
"updated_at": "2026-09-24T17:21:03.120581"
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}{
"error": "Unauthorized",
"error_description": "You are not authorized to use this endpoint."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The app's unique, permanent name: 1-256 lowercase letters, digits or underscores. Chosen at creation and never changes. Slugs are unique regardless of case, so a slug that differs from an existing one only by case is taken.
Pattern:
^[a-z0-9_]{1,256}$Example:
"facebook_connector"
What the app is, what it can do, and how it is listed. Only manifest_version and display_name are required;
everything else may be left out while the app is pending. An active app must also fill the listing card:
short_description, long_description, icon, headline_image, background_color and
developer_information.
Show child attributes
Show child attributes
The key Narrative sends when calling the app's own API. Write-only: it is stored encrypted and never returned by any endpoint.
Example:
"connector-api-key"
Response
Created
Available options:
owned The app's id. Installations refer to the app by it.
Example:
42
The app's unique, permanent name: 1-256 lowercase letters, digits or underscores. Chosen at creation and never changes. Slugs are unique regardless of case, so a slug that differs from an existing one only by case is taken.
Pattern:
^[a-z0-9_]{1,256}$Example:
"facebook_connector"
pending: visible to and installable by the owning company only.active: visible to and installable by every company.archived: visible to nobody.
Available options:
pending, active, archived What the app is, what it can do, and how it is listed. Only manifest_version and display_name are required;
everything else may be left out while the app is pending. An active app must also fill the listing card:
short_description, long_description, icon, headline_image, background_color and
developer_information.
Show child attributes
Show child attributes
The app's OAuth client id, hex-encoded — the form POST /oauth/token accepts.
Example:
"85b558340b635861575c462a10df3bd5"
An ISO-8601 local date-time in UTC, without an offset.
Example:
"2026-09-24T17:21:03.120581"
An ISO-8601 local date-time in UTC, without an offset.
Example:
"2026-09-24T17:21:03.120581"
Was this page helpful?