v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Environment

Export Environment Configuration

Download a JSON file containing all org-settings and event types.

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

post/api/v1/environment/export

Headers

idempotency-keystring

The request's idempotency key

Response

versioninteger

createdAtstring date-time required

settingsobject nullable required

Example response

{
  "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": [
    {
      "id": "trtmpl_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "orgId": "org_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "uid": "unique-identifier",
      "allowedEventTypes": [
        "user.signup",
        "user.deleted"
      ],
      "featureFlags": [
        "cool-new-feature"
      ]
    }
  ]
}