Callbacks

Envelope callback is functionality which allows to receive notification to respective URL in case of envelope appearance in mailbox and according to configured filters. You can set up callbacks for mailbox in order to receive envelope notifications outside of our platform. This is done via API. How to configure callbacks you can see here - Envelope callbacks The administrative panel allows you to view and partially manage callbacks.

Manage callbacks

  1. Navigate to https://platform_address_here/admin/callbacks

../../../../_images/callbacks.png

  1. In the drop-down list, select the mailbox whose callbacks you want to display.

../../../../_images/callbacksChooseMailbox.png

Note

a list of callbacks will be displayed for the selected mailbox if callbacks have been configured via the API. Otherwise the page will be displayed as an empty folder.

3. The list of callbacks contains the following information: - callback URL (1) - authentication type (2) - Basic, None - success code (3) - filter (4) - list of specified filters for a specific callback - actions buttons (5) - settings and delete

../../../../_images/callbacksColumns.png

Check callbacks

  1. Open the Settings button for the selected callback

../../../../_images/callbacksSettings.png

  1. Check callback modal window will be open. Here you can add valid envelope UUID and check callback using the button of the same name.

../../../../_images/callbacksCheck.png

  1. In case if the specified envelope UUID matches the configured filters a corresponding message and an active button “Send a callback” will appear

../../../../_images/callbacksFilterMatch.png

4. Click Send callback button and the following information will be displayed in the modal window: - envelope UUID - responce code - responce body

../../../../_images/callbacksSend.png

Note

you can send callback again, follow back to previous step (enter envelope UUID) or cancel action.

  1. In case if the specified envelope UUID doesn’t match the configured filters a message listing mismatches will be displayed. After that you can just follow back to previous step and enter another envelope UUID or cancel action.

../../../../_images/callbacksFilterNotMatch.png

Delete callbacks

  1. Open the Delete button for the selected callback

../../../../_images/callbacksDelete.png

  1. Delete callback modal window will be opened where you can choose Delete or Cancel action

../../../../_images/callbacksDeleteOrCancel.png

  1. In case you want to delete callback click Delete button and succesful message will be displayed

../../../../_images/callbacksDeleted.png