Retrieves a push and its payload. If the push is active, this request will count as a view and be logged in the audit log.
Passphrase protection - Requires a passphrase to view.
Provide the passphrase as a GET parameter: ?passphrase=xxx
curl -X GET \ -H "Authorization: Bearer MyAPIToken" \ https://pwpush.com/p/fk27vnslkd.json
{
"payload": "secret_text",
"passphrase": null,
"note": "By user initiated request from the user@example.com account",
"expire_after_days": null,
"expire_after_views": null,
"deletable_by_viewer": false,
"retrieval_step": false,
...
}
| Param name | Description |
|---|---|
|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Creates a new push (secret URL) containing the provided payload.
The push must be created with a payload parameter containing the secret content. All other parameters are optional and will use system defaults if not specified.
Pushes can be configured to expire after:
A number of views (expire_after_views)
A number of days (expire_after_days)
Both views and days (first trigger wins)
Passphrase protection requires viewers to enter a secret phrase
Retrieval step helps prevent automated URL scanners from burning views
Deletable by viewer allows recipients to manually expire the push
curl -X POST \
-H "Authorization: Bearer MyAPIToken" \
-H "Content-Type: application/json" \
-d '{"password": {"payload": "secret_text"}}' \
https://pwpush.com/p.json
{
"url_token": "fkwjfvhall92",
"created_at": "2023-10-20T15:32:01Z",
"expires_at": "2023-10-20T15:32:01Z",
"views_remaining": 10,
"passphrase": null,
"note": null,
...
}
| Param name | Description |
|---|---|
|
password
required |
Push details Validations:
|
|
password[payload]
required |
The URL encoded password or secret text to share. Validations:
|
|
password[passphrase]
optional |
Require recipients to enter this passphrase to view the created push. Validations:
|
|
password[note]
optional , blank allowed |
If authenticated, the URL encoded note for this push. Visible only to the push creator. Validations:
|
|
password[expire_after_days]
optional |
Expire secret link and delete after this many days. Validations:
|
|
password[expire_after_views]
optional |
Expire secret link and delete after this many views. Validations:
|
|
password[deletable_by_viewer]
optional |
Allow users to delete passwords once retrieved. Validations:
|
|
password[retrieval_step]
optional |
Helps to avoid chat systems and URL scanners from eating up views. Validations:
|
|
account_id
optional |
The account ID to associate the push with. See: docs.pwpush.com/docs/json-api/#multiple-accounts Validations:
|
This method retrieves the preview URL of a push. This is useful for getting the fully qualified URL of a push before sharing it with others.
curl -X GET \ -H "Authorization: Bearer MyAPIToken" \ https://pwpush.com/p/fk27vnslkd/preview.json
{ "url": "https://pwpush.com/p/fk27vnslkd" }
| Param name | Description |
|---|---|
|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Returns the audit log for a push, containing an array of view events with metadata including:
IP address of viewer
User agent
Referrer URL
Timestamp
Event type (view, failed_view, expire, etc)
Authentication is required. Only the owner of the push can retrieve its audit log. Requests for pushes not owned by the authenticated user will receive a 403 Forbidden response.
curl -X GET \ -H "X-User-Email: user@example.com" \ -H "X-User-Token: MyAPIToken" \ https://pwpush.com/p/fk27vnslkd/audit.json
{
"views": [
{
"ip": "x.x.x.x",
"user_agent": "Mozilla/5.0...",
"referrer": "https://example.com",
"created_at": "2023-10-20T15:32:01Z",
"successful": true,
...
}
]
}
| Param name | Description |
|---|---|
|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Expires a push immediately. Must be authenticated & owner of the push or the push must have been created with deleteable_by_viewer.
curl -X DELETE \ -H "Authorization: Bearer MyAPIToken" \ https://pwpush.com/p/fkwjfvhall92.json
{ "expired": true, "expired_on": "2024-12-10T15:32:01Z" }
| Param name | Description |
|---|---|
|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Returns the list of pushes for your account that are still active.
curl -X GET \ -H "Authorization: Bearer MyAPIToken" \ https://pwpush.com/p/active.json
[
{
"url_token": "fkwjfvhall92",
"created_at": "2023-10-20T15:32:01Z",
"expire_after_days": 7,
"expire_after_views": 1,
"expired": false,
"days_remaining": 7,
"views_remaining": 1,
...
},
...
]
Returns the list of pushes for your account that have expired.
curl -X GET \ -H "Authorization: Bearer MyAPIToken" \ https://pwpush.com/p/expired.json
[
{
"url_token": "fkwjfvhall92",
"created_at": "2023-10-20T15:32:01Z",
"expires_on": "2023-10-23T15:32:01Z",
"expire_after_days": 7,
"expire_after_views": 1,
"expired": true,
...
},
...
]