Back to explore

messaging

Events

Credits: 0.000001

Consume

POST /v1/event/Consume

Consume events from a given topic.

Request

groupstring

Optional group for the subscription

offsetstring

Optional offset to read from e.g "2006-01-02T15:04:05.999Z07:00"

topicstring

The topic to subscribe to

Response

idstring

Unique message id

messageobject

The next json message on the topic

timestampstring

Timestamp of publishing

topicstring

The topic subscribed to

Request

Response

{
    "topic": "events",
    "message": {
        "id": "1",
        "type": "signup",
        "user": "john"
    }
}

Credits: 0.000001

Publish

POST /v1/event/Publish

Publish a event to the event stream.

Request

messageobject

The json message to publish

topicstring

The topic to publish to

Response

{}

Request

Response

{}

Credits: 0.000001

Read

POST /v1/event/Read

Read stored events

Request

limitnumber

number of events to read; default 25

offsetnumber

offset for the events; default 0

topicstring

topic to read from

Response

eventsarray

the events

Request

Response

{
    "events": [
        {
            "id": "123e4567-e89b-12d3-a456-426652340000",
            "message": {
                "id": "1",
                "type": "signup",
                "user": "john"
            }
        }
    ]
}