import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.setIntegrationAsPrimary("integrationId")
<?php
$url = 'https://api.novu.co/v1/integrations/:integrationId/set-primary';
$data = array(
[options]
);
$options = array(
"http" => array(
"header" => "Content-type: application/json",
"header" => "Authorization: ApiKey REPLACE_WITH_API_KEY",
"method" => "POST",
"content" => json_encode($data)
)
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */ }
echo $result;
require 'net/http'
require 'uri'
uri = URI.parse('https://api.novu.co/v1/integrations/:integrationId/set-primary')
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)
request.body = '{
[options]
}'
request.content_type = 'application/json'
request.add_field('Authorization', 'ApiKey REPLACE_WITH_API_KEY')
response = http.request(request)
puts response.body
package main
import (
"fmt"
"net/http"
"encoding/json"
)
func main() {
url := "https://api.novu.co/v1/integrations/:integrationId/set-primary"
data := map[string]string{
[options]
}
jsonValue, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonValue))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "ApiKey REPLACE_WITH_API_KEY")
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(string(body))
}
import requests
response = requests.post('https://api.novu.co/v1/integrations/:integrationId/set-primary')
print(response.json())
{
"_id": "string",
"_environmentId": "string",
"_organizationId": "string",
"name": "string",
"identifier": "string",
"providerId": "string",
"channel": "in_app",
"credentials": {
"apiKey": "string",
"user": "string",
"secretKey": "string",
"domain": "string",
"password": "string",
"host": "string",
"port": "string",
"secure": true,
"region": "string",
"accountSid": "string",
"messageProfileId": "string",
"token": "string",
"from": "string",
"senderName": "string",
"projectName": "string",
"applicationId": "string",
"clientId": "string",
"requireTls": true,
"ignoreTls": true,
"tlsOptions": {},
"baseUrl": "string",
"webhookUrl": "string",
"redirectUrl": "string",
"hmac": true,
"serviceAccount": "string",
"ipPoolName": "string"
},
"active": true,
"deleted": true,
"deletedAt": "string",
"deletedBy": "string",
"primary": true
}
Integrations
Update integration as primary
Update an integration as primary by its unique key identifier integrationId. This API will set the integration as primary for that channel in the current environment. Primary integration is used to deliver notification for sms and email channels in the workflow. Only integration metadata is returned, credentials field is returned as an empty object.
POST
/
v1
/
integrations
/
{integrationId}
/
set-primary
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.setIntegrationAsPrimary("integrationId")
<?php
$url = 'https://api.novu.co/v1/integrations/:integrationId/set-primary';
$data = array(
[options]
);
$options = array(
"http" => array(
"header" => "Content-type: application/json",
"header" => "Authorization: ApiKey REPLACE_WITH_API_KEY",
"method" => "POST",
"content" => json_encode($data)
)
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */ }
echo $result;
require 'net/http'
require 'uri'
uri = URI.parse('https://api.novu.co/v1/integrations/:integrationId/set-primary')
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)
request.body = '{
[options]
}'
request.content_type = 'application/json'
request.add_field('Authorization', 'ApiKey REPLACE_WITH_API_KEY')
response = http.request(request)
puts response.body
package main
import (
"fmt"
"net/http"
"encoding/json"
)
func main() {
url := "https://api.novu.co/v1/integrations/:integrationId/set-primary"
data := map[string]string{
[options]
}
jsonValue, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonValue))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "ApiKey REPLACE_WITH_API_KEY")
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(string(body))
}
import requests
response = requests.post('https://api.novu.co/v1/integrations/:integrationId/set-primary')
print(response.json())
{
"_id": "string",
"_environmentId": "string",
"_organizationId": "string",
"name": "string",
"identifier": "string",
"providerId": "string",
"channel": "in_app",
"credentials": {
"apiKey": "string",
"user": "string",
"secretKey": "string",
"domain": "string",
"password": "string",
"host": "string",
"port": "string",
"secure": true,
"region": "string",
"accountSid": "string",
"messageProfileId": "string",
"token": "string",
"from": "string",
"senderName": "string",
"projectName": "string",
"applicationId": "string",
"clientId": "string",
"requireTls": true,
"ignoreTls": true,
"tlsOptions": {},
"baseUrl": "string",
"webhookUrl": "string",
"redirectUrl": "string",
"hmac": true,
"serviceAccount": "string",
"ipPoolName": "string"
},
"active": true,
"deleted": true,
"deletedAt": "string",
"deletedBy": "string",
"primary": true
}
Enter your API key in the
Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80eimport { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.setIntegrationAsPrimary("integrationId")
<?php
$url = 'https://api.novu.co/v1/integrations/:integrationId/set-primary';
$data = array(
[options]
);
$options = array(
"http" => array(
"header" => "Content-type: application/json",
"header" => "Authorization: ApiKey REPLACE_WITH_API_KEY",
"method" => "POST",
"content" => json_encode($data)
)
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */ }
echo $result;
require 'net/http'
require 'uri'
uri = URI.parse('https://api.novu.co/v1/integrations/:integrationId/set-primary')
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)
request.body = '{
[options]
}'
request.content_type = 'application/json'
request.add_field('Authorization', 'ApiKey REPLACE_WITH_API_KEY')
response = http.request(request)
puts response.body
package main
import (
"fmt"
"net/http"
"encoding/json"
)
func main() {
url := "https://api.novu.co/v1/integrations/:integrationId/set-primary"
data := map[string]string{
[options]
}
jsonValue, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonValue))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "ApiKey REPLACE_WITH_API_KEY")
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(string(body))
}
import requests
response = requests.post('https://api.novu.co/v1/integrations/:integrationId/set-primary')
print(response.json())
{
"_id": "string",
"_environmentId": "string",
"_organizationId": "string",
"name": "string",
"identifier": "string",
"providerId": "string",
"channel": "in_app",
"credentials": {
"apiKey": "string",
"user": "string",
"secretKey": "string",
"domain": "string",
"password": "string",
"host": "string",
"port": "string",
"secure": true,
"region": "string",
"accountSid": "string",
"messageProfileId": "string",
"token": "string",
"from": "string",
"senderName": "string",
"projectName": "string",
"applicationId": "string",
"clientId": "string",
"requireTls": true,
"ignoreTls": true,
"tlsOptions": {},
"baseUrl": "string",
"webhookUrl": "string",
"redirectUrl": "string",
"hmac": true,
"serviceAccount": "string",
"ipPoolName": "string"
},
"active": true,
"deleted": true,
"deletedAt": "string",
"deletedBy": "string",
"primary": true
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Response
Ok
Available options:
in_app, email, sms, chat, push Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I