Integration schema

Integration

Integration is third party service used by Novu to send notification for a specific channel. For example, sengrid is a email integration and twilio is a sms integration. Read more about integrations on integrations concept page.

Prop	Type	Default
`conditions?`	`StepFilterDto[]`	-
`primary?`	`boolean`	-
`deletedBy?`	`string`	-
`deletedAt?`	`string`	-
`deleted?`	`boolean`	-
`active?`	`boolean`	-
`configurations?`	`ConfigurationsDto`	-
`credentials?`	`CredentialsDto`	-
`channel?`	`IntegrationResponseDtoChannel`	-
`providerId?`	`string`	-
`identifier?`	`string`	-
`name?`	`string`	-
`organizationId?`	`string`	-
`environmentId?`	`string`	-
`id?`	`string`	-

Credentials

Each integration has a set of credentials that are used to authenticate with the third party service. Checkout the provider documentation for more details on what credentials are required for each integration.

Prop	Type	Default
`appIOBaseUrl?`	`string`	-
`tenantId?`	`string`	-
`senderId?`	`string`	-
`appSid?`	`string`	-
`accessKey?`	`string`	-
`phoneNumberIdentification?`	`string`	-
`channelId?`	`string`	-
`externalLink?`	`string`	-
`state?`	`string`	-
`imageUrl?`	`string`	-
`title?`	`string`	-
`alertUid?`	`string`	-
`instanceId?`	`string`	-
`authenticationTokenKey?`	`string`	-
`authenticateByToken?`	`boolean`	-
`apiToken?`	`string`	-
`datePath?`	`string`	-
`idPath?`	`string`	-
`secretKeyRequestHeader?`	`string`	-
`apiKeyRequestHeader?`	`string`	-
`ipPoolName?`	`string`	-
`serviceAccount?`	`string`	-
`hmac?`	`boolean`	-
`redirectUrl?`	`string`	-
`webhookUrl?`	`string`	-
`baseUrl?`	`string`	-
`tlsOptions?`	`TlsOptions`	-
`ignoreTls?`	`boolean`	-
`requireTls?`	`boolean`	-
`clientId?`	`string`	-
`applicationId?`	`string`	-
`projectName?`	`string`	-
`senderName?`	`string`	-
`from?`	`string`	-
`token?`	`string`	-
`messageProfileId?`	`string`	-
`accountSid?`	`string`	-
`region?`	`string`	-
`secure?`	`boolean`	-
`port?`	`string`	-
`host?`	`string`	-
`password?`	`string`	-
`domain?`	`string`	-
`secretKey?`	`string`	-
`user?`	`string`	-
`apiKey?`	`string`	-

ChannelTypeEnum

ChannelTypeEnum is used to specify the type of channel that the integration is used for. For example, if the integration is used for email, the channel type will be email.

ChannelTypeEnum {
  IN_APP = "in_app",
  EMAIL = "email",
  SMS = "sms",
  CHAT = "chat",
  PUSH = "push"
}

Integration schema

Integration

Credentials

ChannelTypeEnum

On this page