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
Go
package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Integrations.SetAsPrimary(ctx, "<id>", nil)
if err != nil {
log.Fatal(err)
}
if res.IntegrationResponseDto != nil {
// handle response
}
}import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.integrations.setAsPrimary("<id>");
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Integrations.SetPrimaryAsync(integrationId: "<id>");
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$response = $sdk->integrations->setAsPrimary(
integrationId: '<id>'
);
if ($response->integrationResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.integrations.set_as_primary(integration_id="<id>")
# Handle response
print(res)curl --request POST \
--url https://api.novu.co/v1/integrations/{integrationId}/set-primary \
--header 'Authorization: <api-key>'const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.novu.co/v1/integrations/{integrationId}/set-primary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.novu.co/v1/integrations/{integrationId}/set-primary")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v1/integrations/{integrationId}/set-primary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_environmentId": "<string>",
"_organizationId": "<string>",
"name": "<string>",
"identifier": "<string>",
"providerId": "<string>",
"active": true,
"deleted": true,
"primary": true,
"_id": "<string>",
"channel": "in_app",
"kind": "delivery",
"credentials": {
"apiKey": "<string>",
"user": "<string>",
"secretKey": "<string>",
"hmacSecretKeyEncoding": "text",
"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>",
"configurationSetName": "<string>",
"apiKeyRequestHeader": "<string>",
"secretKeyRequestHeader": "<string>",
"idPath": "<string>",
"datePath": "<string>",
"apiToken": "<string>",
"authenticateByToken": true,
"authenticationTokenKey": "<string>",
"instanceId": "<string>",
"alertUid": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"state": "<string>",
"externalLink": "<string>",
"channelId": "<string>",
"phoneNumberIdentification": "<string>",
"accessKey": "<string>",
"appSid": "<string>",
"senderId": "<string>",
"tenantId": "<string>",
"AppIOBaseUrl": "<string>",
"signingSecret": "<string>",
"outboundIntegrationId": "<string>",
"outboundConnectedAt": "<string>",
"whatsNextCompletedAt": "<string>",
"useFromAddressOverride": true,
"fromAddressOverride": "<string>",
"emailSlugPrefix": "<string>",
"externalEnvironmentId": "<string>",
"externalVaultId": "<string>",
"externalWorkspaceId": "<string>"
},
"configurations": {
"inboundWebhookEnabled": true,
"inboundWebhookSigningKey": "<string>",
"payloadSchema": "<string>"
},
"deletedAt": "<string>",
"deletedBy": "<string>",
"conditions": [
{
"isNegated": true,
"type": "BOOLEAN",
"value": "AND",
"children": [
{
"field": "<string>",
"value": "<string>",
"operator": "LARGER",
"on": "subscriber"
}
]
}
],
"rules": {
"==": [
{
"var": "context.tenant.id"
},
"acme"
]
}
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"errors": {
"fieldName1": {
"messages": [
"Field is required",
"Must be a valid email address"
],
"value": "invalidEmail"
},
"fieldName2": {
"messages": [
"Must be at least 18 years old"
],
"value": 17
},
"fieldName3": {
"messages": [
"Must be a boolean value"
],
"value": true
},
"fieldName4": {
"messages": [
"Must be a valid object"
],
"value": {
"key": "value"
}
},
"fieldName5": {
"messages": [
"Field is missing"
],
"value": null
},
"fieldName6": {
"messages": [
"Undefined value"
]
}
},
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"API rate limit exceeded"{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"Please wait some time, then try again."Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
Headers
A header for idempotency purposes
Path Parameters
Response
OK
The unique identifier for the environment associated with this integration. This links to the Environment collection.
The unique identifier for the organization that owns this integration. This links to the Organization collection.
The name of the integration, which is used to identify it in the user interface.
A unique string identifier for the integration, often used for API calls or internal references.
The identifier for the provider of the integration (e.g., "mailgun", "twilio").
Indicates whether the integration is currently active. An active integration will process events and messages.
Indicates whether the integration has been marked as deleted (soft delete).
Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
The unique identifier of the integration record in the database. This is automatically generated.
The channel type for the integration, which defines how it communicates (e.g., email, SMS). Not set for agent-kind integrations.
Available options:
in_app, email, sms, chat, push, tool Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not have a channel.
Available options:
delivery, agent The decrypted credentials required for the integration to function (e.g. provider API keys, signing secrets). Only returned to dashboard/session-token callers; API-key authenticated callers receive the integration metadata without this field to avoid amplifying API-key leaks into provider-credential leaks.
Show child attributes
Show child attributes
The configurations required for enabling the additional configurations of the integration.
Show child attributes
Show child attributes
The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
The identifier of the user who performed the deletion of this integration. Useful for audit trails.
Legacy StepFilter conditions. Ignored when rules is also set.
Show child attributes
Show child attributes
JSONLogic used at send time to select this integration. Takes precedence over conditions.
Example:
{ "==": [{ "var": "context.tenant.id" }, "acme"] }
Was this page helpful?
⌘I
Go
package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Integrations.SetAsPrimary(ctx, "<id>", nil)
if err != nil {
log.Fatal(err)
}
if res.IntegrationResponseDto != nil {
// handle response
}
}import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.integrations.setAsPrimary("<id>");
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Integrations.SetPrimaryAsync(integrationId: "<id>");
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$response = $sdk->integrations->setAsPrimary(
integrationId: '<id>'
);
if ($response->integrationResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.integrations.set_as_primary(integration_id="<id>")
# Handle response
print(res)curl --request POST \
--url https://api.novu.co/v1/integrations/{integrationId}/set-primary \
--header 'Authorization: <api-key>'const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.novu.co/v1/integrations/{integrationId}/set-primary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.novu.co/v1/integrations/{integrationId}/set-primary")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v1/integrations/{integrationId}/set-primary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_environmentId": "<string>",
"_organizationId": "<string>",
"name": "<string>",
"identifier": "<string>",
"providerId": "<string>",
"active": true,
"deleted": true,
"primary": true,
"_id": "<string>",
"channel": "in_app",
"kind": "delivery",
"credentials": {
"apiKey": "<string>",
"user": "<string>",
"secretKey": "<string>",
"hmacSecretKeyEncoding": "text",
"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>",
"configurationSetName": "<string>",
"apiKeyRequestHeader": "<string>",
"secretKeyRequestHeader": "<string>",
"idPath": "<string>",
"datePath": "<string>",
"apiToken": "<string>",
"authenticateByToken": true,
"authenticationTokenKey": "<string>",
"instanceId": "<string>",
"alertUid": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"state": "<string>",
"externalLink": "<string>",
"channelId": "<string>",
"phoneNumberIdentification": "<string>",
"accessKey": "<string>",
"appSid": "<string>",
"senderId": "<string>",
"tenantId": "<string>",
"AppIOBaseUrl": "<string>",
"signingSecret": "<string>",
"outboundIntegrationId": "<string>",
"outboundConnectedAt": "<string>",
"whatsNextCompletedAt": "<string>",
"useFromAddressOverride": true,
"fromAddressOverride": "<string>",
"emailSlugPrefix": "<string>",
"externalEnvironmentId": "<string>",
"externalVaultId": "<string>",
"externalWorkspaceId": "<string>"
},
"configurations": {
"inboundWebhookEnabled": true,
"inboundWebhookSigningKey": "<string>",
"payloadSchema": "<string>"
},
"deletedAt": "<string>",
"deletedBy": "<string>",
"conditions": [
{
"isNegated": true,
"type": "BOOLEAN",
"value": "AND",
"children": [
{
"field": "<string>",
"value": "<string>",
"operator": "LARGER",
"on": "subscriber"
}
]
}
],
"rules": {
"==": [
{
"var": "context.tenant.id"
},
"acme"
]
}
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"errors": {
"fieldName1": {
"messages": [
"Field is required",
"Must be a valid email address"
],
"value": "invalidEmail"
},
"fieldName2": {
"messages": [
"Must be at least 18 years old"
],
"value": 17
},
"fieldName3": {
"messages": [
"Must be a boolean value"
],
"value": true
},
"fieldName4": {
"messages": [
"Must be a valid object"
],
"value": {
"key": "value"
}
},
"fieldName5": {
"messages": [
"Field is missing"
],
"value": null
},
"fieldName6": {
"messages": [
"Undefined value"
]
}
},
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"API rate limit exceeded"{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"Please wait some time, then try again."