Bookmarks

A bookmark lets you conveniently store and replay a specific request.

Bookmarks

How bookmarks work

Bookmarks are most useful as a library of representative scenarios with which to develop and test your code. For example, a developer for an e-commerce store might bookmark an event that arrives as a result of a gift card order. They could label that bookmark "Gift Card Order Created," and replay that request when testing or troubleshooting that specific logic in their API.

Bookmarked request data is exempt from the archiving period and remains available as long as it is bookmarked.

Add a bookmark

Adding a bookmark will pin a request to the Bookmarks page for future use.

  1. Locate the event you wish to bookmark.
  2. If the event exists in the HTTP View, click the event to select it, then click the bookmark icon at the top of the right-hand sidebar. If the event exists in the CLI View, click the bookmark icon next to the event.
  3. Give the bookmark a descriptive label that will convey its purpose to any collaborators who might encounter it.
  4. Click Add.
POST /bookmarks

The newly bookmarked request can be found on the Bookmarks page.

Edit a bookmark

Editing a bookmark allows you to update its label and associated connection

  1. Go to the Bookmarks page.
  2. Locate the bookmark you wish to edit.
  3. Click the bookmark in the list to pop open the sidebar.
  4. Click the pen icon in the sidebar.
  5. Change the label and/or connection.
  6. Click Save.
PUT /bookmarks/:id

Trigger a bookmark

Triggering a bookmark will replay the event on the associated connection.

When triggered inside the HTTP View, bookmarks will only be sent to HTTP URLs, and not CLIs. When triggered inside the CLI View, bookmarks will only be sent to connected CLIs, and not HTTP URLs.

Contrary to an event retry, triggering a bookmark creates a new event instead of a new attempt.

  1. Go to the Bookmarks page.
  2. Locate the bookmark you wish to replay.
  3. Click the replay button.
POST /bookmarks/:id/trigger

Remove a bookmark

Removing a bookmark will delete it from the Bookmarks page, but won't affect the associated event data.

  1. Go to the Bookmarks page.
  2. Locate the bookmark you wish to remove.
  3. Click the bookmark in the list to pop open the sidebar.
  4. Click the trash icon in the sidebar.
  5. Click Delete Bookmark to confirm.
DELETE /bookmarks/:id
<- Previous Events & Attempts Next -> Issues & Notifications