diff --git a/api/events/index.html b/api/events/index.html index 58998ec78..e386db053 100644 --- a/api/events/index.html +++ b/api/events/index.html @@ -31,11 +31,11 @@ window.addEventListener('beforeunload', () => { localStorage.setItem('sidebar-scroll', leftSidebar.scrollTop); }); -

Events

An event is a record of a user action or outcome. Centrapay performs various tasks in response to events.

+

Events

An event is a record of a user action or outcome. Centrapay performs various tasks in response to events.


POST/api/accounts/{accountId}/events

This endpoint allows you to create an Event   API .

Attributes

  • type

    stringrequired

    The type of Event.

  • idempotencyKey

    stringrequired

    Client-supplied identifier that prevents double creation.

  • data

    string

    An object containing any relevant metadata.

Errors

  • type

    stringrequired

    The type of Event.

  • idempotencyKey

    stringrequired

    Client-supplied identifier that prevents double creation.

  • data

    object

    An object containing any relevant metadata.

Errors

  • EVENT_ALREADY_EXISTS

    403

    An Event with this idempotencyKey has already been created for the account.

Request
POST/api/accounts/Jaim1Cu1Q55uooxSens6yk/events
curl -X POST \
  https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/events \