POST
/api/event-streamingCreate Event Streaming Integration
Creates a new event streaming integration for the authenticated account.
The request body should conform to CreateIntegrationRequest.
Note: Based on the provided Go code, the enabled field from the request is part of the CreateIntegrationRequest struct,
but the backend manager.CreateIntegration function signature shown does not directly use this enabled field.
The actual behavior for enabled during creation should be confirmed (e.g., it might have a server-side default or be handled by other logic).
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
configobjectrequired
Platform-specific configuration as key-value pairs. For creation, all necessary credentials and settings must be provided. For updates, provide the fields to change or the entire new configuration.
enabledbooleanrequired
Specifies whether the integration is enabled. During creation (POST), this value is sent by the client, but the provided backend manager function `CreateIntegration` does not appear to use it directly, so its effect on creation should be verified. During updates (PUT), this field is used to enable or disable the integration.
platformstringrequired
The event streaming platform to integrate with (e.g., "datadog", "s3", "firehose"). This field is used for creation. For updates (PUT), this field, if sent, is ignored by the backend.
200Integration created successfully. Returns the created integration.
account_idstringoptional
The identifier of the account this integration belongs to.
configobjectoptional
Configuration for the integration. Sensitive keys (like API keys, secret keys) are masked with '****' in responses, as indicated by the GetIntegration handler logic.
created_atstringoptional
Timestamp of when the integration was created.
enabledbooleanoptional
Whether the integration is currently active.
idintegeroptional
The unique numeric identifier for the integration.
platformstringoptional
The event streaming platform.
updated_atstringoptional
Timestamp of when the integration was last updated.
400Bad Request (e.g., invalid JSON, missing required fields, validation error).
messagestringoptional
A human-readable error message.
401Unauthorized (e.g., missing or invalid authentication token).
messagestringoptional
A human-readable error message.
500Internal Server Error.
messagestringoptional
A human-readable error message.
Error handling
A 400 is returned: Bad Request (e.g., invalid JSON, missing required fields, validation error). A 401 is returned: Unauthorized (e.g., missing or invalid authentication token). A 500 is returned: Internal Server Error.