Skip to main content

How do I execute an event on an API service that is running?

Objective: This article explains how to execute an event with a payload on an API service via Postman.

Prerequisites:

  • You must have administrator access to the API service. i.e "Log in as Admin".

Steps:

  1. Open Postman.
  2. Execute the Authentication > Admin > Log in as Admin request.
  3. Navigate to the <Service> > Miscellaneous > Execute Event.
  4. Amend the payload to match your desired event:
    • Amend the detail-type property. e.g ListingCreated
    • Amend the detail property if applicable.

Example:

{
...
"detail-type": "ListingCreated", // Name of the event
"detail": {
// Payload:
"raisedAt": "2022-08-12T07:53:54.959Z",
"correlationId": "46f9c292d5fbab5c696b1925fdaa816a",
"commodity": {
...
},
"listing": {
...
}
}
}

Related Articles: