Define subscriber with all subscriptions

PUT 
/subscriber/:subscriber_id

Define or redefine a subscriber with all subscriptions. In case the subscriber does not exist, it is created. In case the subscriber exist, all subscriptions get replaced.

Request

Path Parameters

subscriber_id stringrequired

The identifier of the subscriber

application/json

Body

array

The list of all subscriptions.

• Array [
message_type string

The name of the action to listen to

wait_for_completion boolean

Default value: true

If an action is sent to this subscriber, the event sender should wait until this subscriber has processed the message and send a done message. This is the expected behaviour of every actor and defaults to true.

timeout number

Default value: 60

This is the duration in seconds this subscriber has time to execute the action. After this time the sender assumes a failure and rejects the result of this actor.

• ]

Responses

200

The subscriber

application/json

Schema

Schema

id string

The identifier of this subscriber

subscriptions object

The dictionary of subscriptions, where the key is the message type

property name* Subscription

The definition of an action subscription

message_type string

The name of the action to listen to

wait_for_completion boolean

Default value: true

If an action is sent to this subscriber, the event sender should wait until this subscriber has processed the message and send a done message. This is the expected behaviour of every actor and defaults to true.

timeout number

Default value: 60

This is the duration in seconds this subscriber has time to execute the action. After this time the sender assumes a failure and rejects the result of this actor.

Example (from schema)

{
  "id": "string",
  "subscriptions": {}
}

Loading...