NAnatural
Events

Get event

Changed on

Get an event

get/events/{eventId}

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/events/{eventId}
  • Auth
    HTTP bearer

Path parameters

eventIdstring required

Event ID (evt_*).

Query parameters

customerPartyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • 6663cdab7a7cRevision changes
    • warning

      added the new voiceSession.completed enum value to the // response property for the response status

  • bcf3b028c3e5Revision changes
    • warning

      deleted the query request parameter partyId

    • info

      added the new optional query request parameter customerPartyId