v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Environment

Import Environment Configuration

Import a configuration into the active organization.

It doesn't delete anything, only adds / updates what was passed to it.

Note that the schema for [EnvironmentIn] is subject to change. The fields herein are provided for convenience but should be treated as JSON blobs.

post/api/v1/environment/import

Headers

idempotency-keystring

The request's idempotency key

Request body

settingsobject nullable

Example request

{
  "eventTypes": [
    {
      "name": "user.signup",
      "description": "A user has signed up",
      "schemas": {
        "1": {
          "title": "Invoice Paid Event",
          "description": "An invoice was paid by a user",
          "type": "object",
          "properties": {
            "invoiceId": {
              "description": "The invoice id",
              "type": "string"
            },
            "userId": {
              "description": "The user id",
              "type": "string"
            }
          },
          "required": [
            "invoiceId",
            "userId"
          ]
        }
      },
      "groupName": "user",
      "featureFlags": [
        "cool-new-feature"
      ]
    }
  ],
  "connectors": [
    {
      "name": "My first connector",
      "uid": "unique-identifier",
      "logo": "https://example.com/logo.png",
      "description": "Example connector description",
      "instructions": "Markdown-formatted instructions",
      "allowedEventTypes": [
        "user.signup",
        "user.deleted"
      ],
      "transformation": "function handler(webhook) { /* ... */ }"
    }
  ]
}

Response

no content