Create a Topic

This endpoint creates a new topic in QStash.

POST /v1/topics

curl

curl -X PUT https://qstash.upstash.io/v1/topics/:topicId\
  -H "Authorization: Bearer <token>" \
  -d '{ "name": "test" }'

200

{
  "topicId": "tpc_7EfEryZiheEKzpMuvjYdhhhbNNJA",
  "name": "test",
  "endpoints": [
    {
      "endpointId": "ept_6j7BNZus3ZyPy6P7QtLUMCC3Rq7h",
      "url": "https://www.upstash.com",
      "topicId": "tpc_7EfEryZiheEKzpMuvjYdhhhbNNJA"
    }
  ]
}

Request

name · string · required

The name of the topic Must only contain alphanumeric characters, underscores, dashes and periods. Regex: ^[a-zA-Z0-9-_.]+$

Response

endpoints · Array<Endpoint> · required

Show Endpoint

endpointId · string

The id of the endpoint.

topicId · string

The id of the topic this endpoint subscribes to.

url · string

The url where all requests will be sent to.

name · string · required

A user given name must only contain alphanumeric, hyphen, underscore and periods.

topicId · string · required

Id for this topic

curl

curl -X PUT https://qstash.upstash.io/v1/topics/:topicId\
  -H "Authorization: Bearer <token>" \
  -d '{ "name": "test" }'

200

{
  "topicId": "tpc_7EfEryZiheEKzpMuvjYdhhhbNNJA",
  "name": "test",
  "endpoints": [
    {
      "endpointId": "ept_6j7BNZus3ZyPy6P7QtLUMCC3Rq7h",
      "url": "https://www.upstash.com",
      "topicId": "tpc_7EfEryZiheEKzpMuvjYdhhhbNNJA"
    }
  ]
}