LogoLithic API Documentation

Events

events

Methods

List Events -> CursorPage<
Event
>
get/v1/events

List all events.

Get Event ->
Event
get/v1/events/{event_token}

Get an event.

List Message Attempts For An Event -> CursorPage<
MessageAttempt
>
get/v1/events/{event_token}/attempts

List all the message attempts for a given event.

Domain types

Event = { token, created, event_type, 1 more... }

A single event that affects the transaction state and lifecycle.

EventSubscription = { token, description, disabled, 2 more... }

A subscription to specific event types.

MessageAttempt = { token, created, event_subscription_token, 5 more... }

A subscription to specific event types.

Events

Event Subscriptions

events.event_subscriptions

Methods

Resend Event ->
post/v1/events/{event_token}/event_subscriptions/{event_subscription_token}/resend

Resend an event to an event subscription.

Events

Subscriptions

events.subscriptions

Methods

List Event Subscriptions -> CursorPage<
EventSubscription
>
get/v1/event_subscriptions

List all the event subscriptions.

Create Event Subscription ->
EventSubscription
post/v1/event_subscriptions

Create a new event subscription.

Get Event Subscription ->
EventSubscription
get/v1/event_subscriptions/{event_subscription_token}

Get an event subscription.

Update Event Subscription ->
EventSubscription
patch/v1/event_subscriptions/{event_subscription_token}

Update an event subscription.

Delete Event Subscription ->
delete/v1/event_subscriptions/{event_subscription_token}

Delete an event subscription.

Resend Failed Messages ->
post/v1/event_subscriptions/{event_subscription_token}/recover

Resend all failed messages since a given time.

List Message Attempts For An Event Subscription -> CursorPage<
MessageAttempt
>
get/v1/event_subscriptions/{event_subscription_token}/attempts

List all the message attempts for a given event subscription.

Replay Missing Messages ->
post/v1/event_subscriptions/{event_subscription_token}/replay_missing

Replays messages to the endpoint. Only messages that were created after begin will be sent. Messages that were previously sent to the endpoint are not resent. Message will be retried if endpoint responds with a non-2xx status code. See Retry Schedule for details.

Get Event Subscription Secret -> { secret }
get/v1/event_subscriptions/{event_subscription_token}/secret

Get the secret for an event subscription.

Rotate Event Subscription Secret ->
post/v1/event_subscriptions/{event_subscription_token}/secret/rotate

Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours.

path Parameters
event_subscription_token: string
Request example
Send Event Type Example Message ->
post/v1/simulate/event_subscriptions/{event_subscription_token}/send_example

Send an example message for event.