Test Email Integration

Test an email integration.

The Email channel handles transactional and campaign email — templates, footers, signatures, campaigns, and provider integrations.

Tests the email integration.

Test an email integration

post

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

multipart/form-dataapplication/json

Test an email integration

integrationIdstringRequired

The email integration id to test. Get it from get_email_integrations.

tostringRequired

The recipient email address to send the test email to.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

correlationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

post/{version}/notifications/email/integrations/test

HTTPcURLJavaScriptPython

POST /{version}/notifications/email/integrations/test HTTP/1.1
Host: hub.norbix.ai
Content-Type: multipart/form-data
Accept: */*
Content-Length: 177

{
  "integrationId": "text",
  "to": "text",
  "projectId": "text",
  "env": "text",
  "resolvedEnv": {
    "value": "text",
    "isProd": true
  },
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "items": [
    {}
  ]
}

In the dashboard

Manage this visually in Norbix Cloud — see Notifications.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Test Email Integration in the SDK reference, with examples in every language.