Consumers

Registering a consumer tells ShoulderTap which kinds it handles and where to deliver answers. This endpoint registers webhook consumers; in-process consumers are registered through the SDK.

Register a consumer

POST /api/v1/consumers Body is a ConsumerRegistration. Required: id, handles_kinds, delivery.

curl -X POST http://localhost:8776/api/v1/consumers \
  -H "Authorization: Bearer $SHOULDERTAP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "my-consumer",
    "handles_kinds": ["glossary.definition", "freeform.answer"],
    "delivery": {"type": "webhook", "url": "https://my-service.example.com/shouldertap-webhook"},
    "dedup_window": "PT24H"
  }'

Returns 201 Created with { id }. See Webhook consumers for the event payloads your URL will receive.

string

required

The consumer’s id.

array

required

Kinds this consumer deals with.

object

required

{ "type": "webhook", "url": "..." } for a webhook consumer.

string

default:"P1D"

ISO-8601 duration for deduplication.

boolean

default:"false"

Deliver without human review. See the warning.

object

Optional custom capture schemas per kind. See Kinds.

Unregister a consumer

DELETE /api/v1/consumers/{id}

curl -X DELETE http://localhost:8776/api/v1/consumers/my-consumer \
  -H "Authorization: Bearer $SHOULDERTAP_API_TOKEN"

Returns 204 No Content.

Overview

Contracts

Endpoints

Register a consumer

Unregister a consumer

​Register a consumer

​Unregister a consumer

Register a consumer

Unregister a consumer