Cookies and Webhooks in Ready API

Webhooks

A webhook sends a POST request to a given URL every time an API is saved or published in SwaggerHub. You can use webhooks to alert external systems when your API definitions are updated. And to start your own actions depending on events from SwaggerHub.

Webhooks transmit data via an HTTP POST request with any useful content. The application/JSON content type is used by most webhooks.

Add a Webhook

Note: You can only add or change the Webhook if you are the API coordinator.

Follow the below steps to add a Webhook.

Step 1: In the SwaggerHub editor, open the API.

Step 2: Select the version you want to add to the Webhook.

Step 3: Click on the API name and select the Integrations tab. Now, click on the Add New Integration button.

Step 4: Select the Webhook from the list.

Step 5: Now, configure the Webhook like Name, content type, etc.

Step 6: Click on Create and done.

Testing Webhooks

Using VirtResponse test steps, Ready API can handle webhook requests. Set up the REST VirtResponse or SOAP VirtResponse test step to receive a request through a webhook. Assertions can also analyze a request and verify if your webhook is sending the correct message.

Catching Webhook Messages

In this section, we will use GitHub Webhook to learn the Catching Webhook Messages. Follow the below steps.

Step 1: Create a Webhook.

Step 2: To make your local host accessible over the Internet, use ngrok.

Step 3: Run ngrok using the command given below.

ngrok http 4567

Step 4: The Forwarding line should look like this.

Forwarding http://8a6f5e6e.ngrok.io -> localhost:4567

Step 5: Go to Setting and copy the Payload URL.

Step 6: Using this URL, open ReadyAPI and create a new project.

http://localhost:4567/payload

Step 7: The service you built at port 4567 should be used in a REST VirtResponse test step:

Step 8: Set the VirtResponse's POST request method.

Step 9: Start the test case after boosting the value of the Timeout property.

Frequently Asked Questions

What type of data sources can be used in Ready API?

There are a lot of data sources that can be used in Ready API. Examples are JDBC, Grid, Groovy, Excel, File, and Using Data Sources. A user can use any of these methods as a data source.

How do I pass cookies in soapUI?

Create a header attribute in soapUI with the same value as the one you got from the browser, then send the request. The same session id (JSESSIONID) kept in the cookie will be used to execute the request. 

What is test runner ReadyAPI?

The test runner lets you run functional tests and export results. The runner can be started using the ReadyAPI user interface or the command line. When you need to build the command line and check the settings, the latter method is helpful.

Conclusion

We have discussed the topic of Cookies and Webhooks in Ready API in this article. In detail, we have seen working, functional, and performance tests, along with adding, testing, and catching Webhook.

We hope this blog has helped you enhance your knowledge of Cookies and Webhooks in Ready API. If you want to learn more, check out our articles.

⚡ Running tests in ReadyAPI.

⚡ Managing test items in Ready API.

⚡ What are the test steps in Ready API?

And many more on our platform Coding Ninjas Studio.

But suppose you have just started your learning process and are looking for questions from tech giants like Amazon, Microsoft, Uber, etc. In that case, you must look at the problems, interview experiences, and interview bundles for placement preparations.

However, you may consider our paid courses to give your career an edge over others!

Happy Learning!