Skip to content

All resources

task-subscriptions

3 endpoints

post /tasks/{id}/subscribe

Subscribe to a task

Requires authentication

Subscribes the caller to a task's activity. Idempotent — a repeat call returns the same subscribed:true payload.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

delete /tasks/{id}/subscribe

Unsubscribe from a task

Requires authentication

Removes the caller's subscription to a task. Idempotent — returns subscribed:false either way.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

get /tasks/{id}/subscription

Get a task's subscription state

Requires authentication

Returns the caller's subscribed flag plus the task's total subscriber count.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope