Create a subscription

POST

/api/subscriptions

Maintainer:Not configured

OperationId:create_subscription

Declares that a team, context or cogmap wants the events a connection emits that match selector. Requires a system admin (not on someone else's personal team, nor for someone else's personal context as subscriber) or an owner or maintainer of authoring_team_id, and, for every caller, that the authoring team holds read-reach on the connection. A context or cogmap subscriber must be linked to the authoring team; a team subscriber must be the authoring team itself. A selector that can never match the connection's registered webhook events is refused.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The created subscription

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/subscriptions' \
--header 'X-Temper-Surface;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "authoring_team_id": "432dfed4-c020-4ab1-b770-05cbb7f5cbf9",
    "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
    "selector": {
        "event_types": [
            "string"
        ],
        "kind": "git_hub_repository",
        "repo": "string"
    },
    "subscriber_id": "58967d7e-739c-49b3-a104-d145fb6fd05f",
    "subscriber_table": "string"
}'

Response Example

200 - Example 1

{
    "authoring_team_id": "432dfed4-c020-4ab1-b770-05cbb7f5cbf9",
    "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
    "created": "2019-08-24T14:15:22.123Z",
    "created_by_profile_id": "6b2b56d0-7405-4266-ad1f-a8cd42d8a5ea",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "revoked_at": "2019-08-24T14:15:22.123Z",
    "revoked_by_profile_id": "e2512452-9e5c-40a6-8117-21bb43a829e4",
    "selector": null,
    "subscriber_id": "58967d7e-739c-49b3-a104-d145fb6fd05f",
    "subscriber_table": "string"
}

Modified at 2026-10-31 18:33:26

List subscriptions

Get a subscription