---
title: "Request to create a new subscription"
method: POST
path: "/v1/externalevents/requests/creation"
tags: ["Edit Subscriptions", "Requests"]
---

# Request to create a new subscription

`POST /v1/externalevents/requests/creation`

## Request

- Base URL: `https://api.tetrascience.com`
- URL: `https://api.tetrascience.com/v1/externalevents/requests/creation`
- Auth: API key in header `x-org-slug` and API key in header `ts-auth-token`

## Request body

- EventbridgeExternalSubscriptionCreate
  - `selectedEventTypes` string[], required: The types of events to subscribe to
  - `userDefinedName` string, required: Subscription name set and displayed in the UI
  - `targetEndpoint` string, required: Amazon Resource Name of the bus resource where events should be sent
  - `targetType` 'BUS', required
  - `enabled` boolean, required

## Response `200`

Request created successfully

- union
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required: The types of events to subscribe to
      - `userDefinedName` string, required: Subscription name set and displayed in the UI
      - `targetEndpoint` string, required: Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'queued', required
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required: The types of events to subscribe to
      - `userDefinedName` string, required: Subscription name set and displayed in the UI
      - `targetEndpoint` string, required: Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'in-progress', required
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required: The types of events to subscribe to
      - `userDefinedName` string, required: Subscription name set and displayed in the UI
      - `targetEndpoint` string, required: Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'failed', required
    - `output` object, required
      - `message` string, required
  - object
    - `orgSlug` string, required
    - `type` 'create', required
    - `input` object, required
      - `id` string, required
      - `orgSlug` string, required
      - `selectedEventTypes` string[], required: The types of events to subscribe to
      - `userDefinedName` string, required: Subscription name set and displayed in the UI
      - `targetEndpoint` string, required: Amazon Resource Name of the bus resource where events should be sent
      - `targetType` 'BUS', required
      - `enabled` boolean, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'completed', required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[]: The types of events to subscribe to
        - `userDefinedName` string: Subscription name set and displayed in the UI
        - `targetEndpoint` string: Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'queued', required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[]: The types of events to subscribe to
        - `userDefinedName` string: Subscription name set and displayed in the UI
        - `targetEndpoint` string: Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'in-progress', required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[]: The types of events to subscribe to
        - `userDefinedName` string: Subscription name set and displayed in the UI
        - `targetEndpoint` string: Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'failed', required
    - `output` object, required
      - `message` string, required
  - object
    - `orgSlug` string, required
    - `type` 'update', required
    - `input` object, required
      - `id` string, required
      - `update` object, required
        - `selectedEventTypes` string[]: The types of events to subscribe to
        - `userDefinedName` string: Subscription name set and displayed in the UI
        - `targetEndpoint` string: Amazon Resource Name of the bus resource where events should be sent
        - `targetType` 'BUS'
        - `enabled` boolean
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'completed', required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'queued', required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'in-progress', required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'failed', required
    - `output` object, required
      - `message` string, required
  - object
    - `orgSlug` string, required
    - `type` 'delete', required
    - `input` object, required
      - `id` string, required
    - `createdAt` string, date-time, required
    - `lastUpdatedAt` string, date-time, required
    - `id` string, required
    - `status` 'completed', required

## Other responses

- `400`: Incorrect input provided
- `404`: Not found or not visible to user
- `500`: Internal error managing rules on eventbridge
- `501`: Internal error managing rules on eventbridge

---

[API](https://skmtc.dev/tetrascience/apis/event-subscriptions-api.md) - [All operations](https://skmtc.dev/tetrascience/apis/event-subscriptions-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrascience/apis/event-subscriptions-api/revisions/781d17951837?raw)