a13nDocs
API referenceSubscriptions

Create Subscription

The response is the only time the signing secret is returned.

POST/api/v1/subscriptions

The response is the only time the signing secret is returned.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Without signing_secret the service generates one; either way it is returned only by this request.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "kinds": [      "run.accepted"    ],    "name": "string",    "url": "string"  }'
{  "created_at": "2019-08-24T14:15:22Z",  "created_by_id": "string",  "enabled": true,  "filter": {    "agent_id": "string",    "session_id": "string",    "thread_id": "string"  },  "id": "string",  "kinds": [    "string"  ],  "name": "string",  "signing_secret": "string",  "updated_at": "2019-08-24T14:15:22Z",  "updated_by_id": "string",  "url": "string",  "version": 0,  "workspace_id": "string"}