{"info":{"_postman_id":"f6ddb350-367c-4599-99e1-566f5a656d45","name":"PostPopUp","description":"

Create and deliver great looking popups from any source simply by calling our API. Popups from your App, eCommerce Platform, CRM & more.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3233906","collectionId":"f6ddb350-367c-4599-99e1-566f5a656d45","publishedId":"2sA3s1psaW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"115E59"},"publishDate":"2024-08-09T09:19:48.000Z"},"item":[{"name":"Update TriggeredAt (Webhook)","id":"4e9dc25a-7aa9-4931-91a0-73cd1aa58402","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.postpopup.com/api/popups/{{popupId}}/trigger","description":"

Update TriggeredAt

This endpoint triggers a specific popup identified by the popupId. This route is used to update the triggeredAt date which will keep your popups relative date fresh. For example, instead of showing \"2 weeks ago\" calling this route will update it the current date time so the popup will now show \"1 minute ago\".

Request

Method: POST
\n
URL: https://api.postpopup.com/api/popups/{{popupId}}/trigger
\n
Headers:
\n
- Content-Type: application/json
  \n
- Authorization: Bearer
  \n
\n

Request Body

(optional): Any body can be sent to this API route but it will be ignored. PostPopUp automatically updates the TriggeredAt time when the API is called.

Response

The response for this request is a JSON schema. Please refer to the schema for details.

This endpoint triggers a specific popup identified by the popupId

The PopupId can be found on the Popups page in the PostPopUp portal.

\n","urlObject":{"protocol":"https","path":["api","popups","{{popupId}}","trigger"],"host":["api","postpopup","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e9dc25a-7aa9-4931-91a0-73cd1aa58402"},{"name":"Create Popup","id":"d9ecb7f2-95a6-4dcf-ba2a-14ca86a55b97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"domainId\": \"[YOUR_DOMAIN_ID]\",\n \"message\": \"The message for the popup!\",\n \"iconUrl\": \"https://example.com/icon.jpg\",\n \"expiresAt\": \"2024-12-31T23:59:59Z\",\n \"triggeredAt\": \"2024-12-31T23:59:59Z\",\n \"source\": \"Your Website or App\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.postpopup.com/api/popups/create","description":"

This endpoint allows you to create a new popup. The request should be sent via an HTTP POST to the specified URL. The request body should be in raw JSON format and include the following parameters:

domainId (string): The ID of the domain for which the popup is created, get this from the PostPopUp Domains page.
\n
message (string): The message to be displayed on the popup.
\n
iconUrl (string): The URL of the icon to be displayed in the popup.
\n
expiresAt (string): The expiration date and time for the popup, this will prevent it showing after the expiry.
\n
triggeredAt (string): The date and time when the popup is triggered, this will show on the popup as a relative time e.g. 1 day ago/1 hour ago.
\n
source (string): The source of the popup e.g. Example.com, Your App, Your Website, Stripe.
\n

The response of this request is documented as a JSON schema.

\n","urlObject":{"protocol":"https","path":["api","popups","create"],"host":["api","postpopup","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9ecb7f2-95a6-4dcf-ba2a-14ca86a55b97"}]}