SendGrid
Create SendGrid Integration
By configuring this integration, the system will be able to send email notifications, alerts, and automated messages through the SendGrid service.
Endpoint: POST/integrations
Request Body
| Field | Type | Description |
|---|---|---|
| integration | integer | Unique identifier of the integration type to be configured. |
| data | object | Configuration object containing service-specific parameters. |
| data.environment | string | Defines the operational environment. • stage: Staging/testing environment. • production: Live production environment. |
| data.api_key | string | API key used to authenticate requests to the SendGrid service. |
| data.from_email | string | Default sender email address used when sending messages through SendGrid. |
| data.from_name | string | Display name associated with the sender email address. |
data.api_key must be treated as a secret credential. Ensure it is never exposed in logs, screenshots, or public repositories.Request Example
{
"integration": 4,
"data": {
"environment": "stage",
"api_key": "SG.xxxxxxxxxxxxxxxxxxxx",
"from_email": "notifications@yourcompany.com.br",
"from_name": "Enspace Notifications"
}
}Response Example
{
"id": 105,
"data": {
"changeKeys": false,
"environment": "stage"
},
"integration": {
"id": 4,
"name": "Sendgrid",
"description": "integrations.sendgrid.description",
"category": "integrations.sendgrid.category",
"slug": "sendgrid",
"created_at": "2025-06-17T15:40:10.419Z",
"updated_at": "2025-06-17T15:40:10.419Z",
"media": []
},
"status": "active",
"created_at": "2026-03-12T20:55:53.111Z",
"updated_at": "2026-03-12T20:55:53.132Z"
}Response Fields
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the created integration configuration. |
| integration | object | Object containing metadata about the configured integration service. |
| status | string | Current operational status of the integration. • active: Enabled and operational. • inactive: Currently disabled. |
| data | object | An object containing the applied configuration parameters. |
| created_at | datetime | ISO 8601 timestamp indicating when the integration was created. |
| updated_at | datetime | ISO 8601 timestamp indicating the last update to the configuration. |
api_key are omitted from the response body.