Websocket connections with Postman

Question

I'm using Postman to test an existing REST API. This API calls async functions on the server which return a response over a websocket using StompJS.

Is it possible to connect to the websocket using Postman?

Thanks, @TheEnvironmentalist, Domain changed to https://firecamp.io — Nishchit, Aug 28 '20 at 07:51
This is now possible in Postman - https://blog.postman.com/postman-supports-websocket-apis/ — Danny Dainton, May 20 '21 at 14:43

score 97 · Answer 1 · edited Jul 06 '22 at 18:48

97

Update: May 20, 2021, As of version 8.5.0 - Postman supported WebSocket APIs

Obsolete (original) answer:

This is not possible as of May 2017. There is a request for this if you want to upvote: github.com/postmanlabs/postman-app-support/issues/4009

edited Jul 06 '22 at 18:48

T.Todua

53,146
19
236
237

answered May 03 '17 at 08:16

kien bui

1,760
2
17
33

3

As of version 8.5.0 - Postman supports WebSocket APIs. The linked Github issue has now been closed. – Danny Dainton May 20 '21 at 14:42
1

@DannyDainton Thank you for your information. I will update my answer. – kien bui May 20 '21 at 17:21
@DannyDainton how do you can see on postman about send api call that reply not with a res.send but with a socket.emit? – July Jun 02 '21 at 00:48

score 65 · Answer 2 · answered Jul 13 '17 at 17:27

65

As the previous comment mentioned you can't do this in Postman. however, I found this Chrome app in the web store. It is very simple, but it's working really well with my local web socket connections.

Smart Websocket Client

answered Jul 13 '17 at 17:27

JoshSommer

2,550
18
23

3

thanks for the quick solution almost 3 years later why no postman do this? – Christian Matthew Sep 27 '19 at 18:16
1

Thank you @JoshSommer. Easy simple and tool, what I need. – Denys Nov 11 '20 at 21:36

Mohammad Rafigh · Answer 3 · 2020-11-26T11:38:08.687

29

It's not possible in Postman yet; But there is a new alternative for Postman, named Postwoman. it's open source and supports realtime Websocket and SSE requests.

Update

It seems they have rebranded Postwoman to Hoppscotch and have improved the Websocket support.

edited Nov 26 '20 at 11:38

answered Dec 12 '19 at 23:02

Mohammad Rafigh

757
9
17

6

Not usable for requests to `localhost` _yet_ – raphinesse Jan 31 '20 at 16:52
1

`127.0.0.1` works for now but local network calls like 192.168.x.x doesn't work. – Mohammad Rafigh Feb 04 '20 at 14:08
unfortunately it doesn't allow you to save requests/messages like Postman does – Sebastien H. Nov 24 '20 at 16:36
1

Thanks! It is useful. – Abhishek Pankar Mar 25 '21 at 18:30

Tom · Answer 4 · 2020-01-30T23:34:32.117

29

Postman doesn't support it, but WebSocket King does.

edited Jan 30 '20 at 23:34

answered Dec 31 '19 at 11:20

Tom

950
3
15
27

1

There is also a [Chrome extension](https://chrome.google.com/webstore/detail/websocket-king-client/cbcbkhdmedgianpaifchdaddpnmgnknn/related?hl=en) if you fancy that. – Sal Alturaigi Apr 07 '21 at 10:30

Danny Dainton · Answer 5 · 2021-05-22T07:57:24.657

29

As of version 8.5.0 - Postman now supports WebSocket requests.

More information can be found here:

https://blog.postman.com/postman-supports-websocket-apis/

Short Level Up video tutorial of the current functionality:

https://youtu.be/H-7EZVj9D-k

edited May 22 '21 at 07:57

answered May 20 '21 at 13:53

Danny Dainton

23,069
6
67
80

score 13 · Answer 6 · answered Mar 05 '19 at 08:23

13

I've run into this issue often enough that I finally created my own barebones GUI for testing websockets. It's called Socket Wrench, it supports

multiple concurrent connections to servers (with all responses and connections displayed in the same view),
comprehensive message history to enable easy re-use of messages, and
custom headers for the initial connection request.

It's available for Mac OS X, Windows and Linux and you can get it from here.

answered Mar 05 '19 at 08:23

asleepysamurai

1,362
2
14
23

Looks like an interesting project. I'm hitting some errors; I'll follow up with a GitHub issue. – Holistic Developer Apr 08 '19 at 20:00
@EmmanuelMahuni Could you please open a [Github issue](https://github.com/asleepysamurai/socketwrench/issues) with steps to reproduce? – asleepysamurai May 13 '19 at 12:00
not bad... i like it. wish there was a way to save the output and the json preview is worse than the text preview. the json should be pretty and the rest should be.. well text – Christian Matthew Sep 27 '19 at 19:51
very good project. nice work... needs just a couple improvements – Christian Matthew Sep 27 '19 at 20:54
@ChristianMatthew Please open a [Github issue](https://github.com/asleepysamurai/socketwrench/issues) on the project, I'll look into implementing it soon :) – asleepysamurai Sep 28 '19 at 22:31

BiJ · Answer 7 · 2019-10-19T00:35:48.093

11

You can use the tool APIC available here https://chrome.google.com/webstore/detail/apic-complete-api-solutio/ggnhohnkfcpcanfekomdkjffnfcjnjam. This tool allows you to test websocket which use either StompJS or native Websocket. More info here at www.apic.app

edited Oct 19 '19 at 00:35

answered Sep 18 '17 at 06:24

BiJ

1,639
5
24
55

Great! but It is beta yet. I an waiting for release. – F.Tamy Oct 06 '19 at 16:02
1

That myapic.com url appears to have expired and been taken over by an ad squatter. Looks like they currently use https://apic.app/ instead – David Woods Oct 16 '19 at 00:05
@F.Tamy It seems that it is not beta anymore – Hola Soy Edu Feliz Navidad Sep 22 '20 at 19:07
Yes, It is great – F.Tamy Sep 27 '20 at 00:11

score 6 · Answer 8 · answered Jul 11 '18 at 18:27

6

I ran into the exact same problem. Had to make a Web Socket call. I was able to accomplish this using Advanced Rest Client. I'm using ARC version : 12.1.3

answered Jul 11 '18 at 18:27

John

2,445
2
17
25

4

No way to customize anything on the WS request though, just an address field! – caesarsol Jul 20 '18 at 18:00
I'm stuck with same problem. I need to set custom headers on connect request, but looks like it's impossible for now – Dub Nazar Sep 11 '18 at 20:38
2

@DubNazar If you're still interested, you could use [Socket Wrench](https://asleepysamurai.com/articles/socketwrench?ref=stackoverflow/42269075) – asleepysamurai Mar 05 '19 at 08:20

Anand Singh · Answer 9 · 2022-11-18T05:44:52.947

4

Postman currently does not support that.

You can use the online tool at: https://www.piesocket.com/websocket-tester

edited Nov 18 '22 at 05:44

answered Nov 26 '19 at 23:09

Anand Singh

1,091
13
21

score 3 · Answer 10 · answered Feb 05 '20 at 09:29

Postman doesn't support websocket. Most of the extension and app I had ever seen were not working properly.

Solution which I found

Just login/ open your application in your browser, and open browser console. Then enter your socket event, and press enter.

socket.emit("event_name", {"id":"123"}, (res)=>{console.log(res); });

score 2 · Answer 11 · answered Mar 28 '19 at 12:46

2

You can use Socket.io tester, this app lets you connect to a socket.io server and subscribe to a certain topic and/or lets you send socket messages to the server

answered Mar 28 '19 at 12:46

Amine Harbaoui

1,247
2
17
34

this is not what the op is looking for at all – Christian Matthew Sep 27 '19 at 19:49
This does not connect on localhost – Ravishankar Jan 06 '21 at 00:24

Tokiniaina Eddy Andriamiandris · Answer 12 · 2021-05-23T15:03:43.090

2

Use Firecamp , support websocket(Socketio & Ws ) ,Rest, Graphql , You can install in your système or use plugin https://firecamp.io/

edited May 23 '21 at 15:03

answered May 23 '21 at 14:52

Tokiniaina Eddy Andriamiandris

1,139
11
9

score 1 · Answer 13 · answered May 24 '21 at 18:33

Have not discovered that postman released web sockets function, but in any case i recently wrote my own simple very simple utility with pure js & html (no bootstrap, no npm, no heavy libs), maybe it would be useful for someone: https://github.com/Wissance/wstester

Websocket connections with Postman

13 Answers13

Linked