How to send a SSE request in Apidog?

SSE is a real-time communication technology built upon the HTTP protocol. It enables a persistent, unidirectional connection between the client and server, allowing the server to push asynchronous messages to the client.

Initiating an SSE Connection

To establish an SSE connection, create a new API within your HTTP project. Upon sending the request, if the response header Content-Type includes text/event-stream, Apidog will automatically parse the returned data as SSE events. The response content will be updated in real-time within a new timeline view, eliminating the need to wait for the server to close the connection.

Extracting Message Content with Post-Request Scripts

You can utilize custom scripts in the Post processor scripts section of your API to extract specific field values from each SSE event and concatenate them into a complete string.

For instance, consider the API illustrated in the diagram above. Each message returned by this API contains a JSON structure. Our objective is to extract the answer field from the response and combine its parameter contents into a single text string.

Insert the following example code into the custom script:

After sending the request, the concatenated text will be displayed in the Visualize section of the Body.

How to send a SSE request in Apidog?

Initiating an SSE Connection#

Extracting Message Content with Post-Request Scripts#

Initiating an SSE Connection

Extracting Message Content with Post-Request Scripts