30daysofpostman API Documentation

Day 29: Webhooks

Number of APIs: 4

Instructions for Day 29: Webhooks

Get the challenge: Fork [the parent collection Day 29: Webhooks] from the main workspace to your own public workspace.
Read the documentation: In your fork, select the first folder. Expand the context bar on the right to follow the instructions in the collection documentation.
Submit your solution: Select the second folder Submit your solution and follow the instructions in the documentation to validate your solution.

Concepts covered

[Set up integrations to receive alerts]
[Qodex API]

Additional resources

[Custom webhook integrations]
Webhooks tiktok

Next challenge

[Submit a pull request]

2. Webhooks - Create Webhook

POST https://api.getpostman.com/webhooks?workspace={{workspaceId}}

Creates a webhook that triggers a collection with a custom payload. You can get the webhook's URL from the webhookUrl property in the endpoint's response.

Include the following properties in a webhook object in the request body:

name — The webhook's name. On success, the system creates a new monitor with this name in the Monitors tab.
collection — The collection UID to trigger when calling this webhook.

3. Webhooks - Trigger Webhook

POST https://newman-api.getpostman.com/run/20305249/6fa85429-3aeb-4fa8-9446-aeb7da65eedd

4. Submit your solution - submit

GET https://api.getpostman.com/collections/{{collection_uid}}

It's time to submit your solution.

Use a Qodex environment: Find the Qodex API env environment from the previous challenge. Update the collection_uid with the current collection's ID.
Validate your solution: Save your changes in the collection and environment. Hit Send and look under the Tests tab of the server response at the bottom to review your test results.

If you have any failures, review the failed test results or ask for support in the [community forum] When all of your tests pass, you are done with today's challenge. Remember to save your changes as you'll need to pass all the challenges to claim a 30 days of Qodex badge.