The Web Push API works in two steps. A create request makes a campaign in Draft status. A launch request sends it. A successful create response does not send any push notification.
Send your first campaign to a small test segment, and subscribe a test browser before you launch.
Check the result in the InOne panel
Go to the Web Push campaign list in the InOne panel.
Find the campaign by the name you sent. Filter the list by status if needed. After the create request, the status is Draft.
Open the campaign and check the title, message, and audience against your request.
Send the launch request. Refresh the list and check that the status changes.
On your subscribed test browser, confirm that the notification arrives.
Interpret a partial success response
Response | Meaning | What to do |
|---|---|---|
Success on create | Insider One saved a Draft campaign. | Save the campaign ID from the response and use it in the launch request. |
Success on launch | Insider One queued the campaign. | Check the campaign status and your test browser. |
Error with a message | The request failed validation. | Fix the field named in the message and resend. |
If the campaign stays in Draft after launch, check the launch request response for an error message. If you leave out include_unengage, the campaign excludes unengaged subscribers by default.
Reproduce a failure in Postman
Open the endpoint page and select Run in Postman. The Insider One Postman documentation opens at that endpoint.
In the top right corner of the Postman documentation, select Run in Postman.
In the Fork collection into your workspace window, select Fork Collection. Postman opens the collection in the Postman app or in your browser.
Select the environment that holds your API key and partner name.
In the Body tab, select raw and paste the payload from your integration.
Select Send and compare the response with your integration log.
Reduce the payload to the required fields, then add fields back until the error returns.
Remove the API key before you share the request or response.
To trigger a known error on purpose, send a launch request with a campaign ID that does not exist.
For more information, see Insider One APIs in Postman and API Status and Error Codes.