URL Pushes
Interact directly with URL pushes. This feature (and corresponding API) is currently in beta.

>>>

GET /r/:url_token.json
Retrieve a URL push.

Retrieves a push including it’s payload and details. If the push is still active, this will burn a view and the transaction will be logged in the push audit log.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fk27vnslkd.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

POST /r.json
Create a new URL push.

Supported Formats

json

Examples

curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" --data "url[payload]=myurl&url[expire_after_days]=2&url[expire_after_views]=10" https://pwpush.com/r.json

Params

Param name Description
url
required

Push details

Validations:

  • Must be a Hash
url[payload]
required

The URL encoded URL to redirect to.

Validations:

  • Must be a String
url[passphrase]
optional

Require recipients to enter this passphrase to view the created push.

Validations:

  • Must be a String
url[note]
optional

If authenticated, the URL encoded note for this push. Visible only to the push creator.

Validations:

  • Must be a String
url[expire_after_days]
optional

Expire secret link and delete after this many days.

Validations:

  • Must be a Integer
url[expire_after_views]
optional

Expire secret link and delete after this many views.

Validations:

  • Must be a Integer
url[retrieval_step]
optional

Helps to avoid chat systems and URL scanners from eating up views.

Validations:

  • Must be one of: true, false, 1, 0.
>>>

GET /r/:url_token/preview.json
Helper endpoint to retrieve the fully qualified secret URL of a push.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fk27vnslkd/preview.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

GET /r/:url_token/audit.json
Retrieve the audit log for a push.

This will return array of views including IP, referrer and other such metadata. The successful field indicates whether the view was made while the push was still active (and not expired). Note that you must be the owner of the push to retrieve the audit log and this call will always return 401 Unauthorized for pushes not owned by the credentials provided.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fk27vnslkd/audit.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

DELETE /r/:url_token.json
Expire a push: delete the payload and expire the secret URL.

Expires a push immediately. Must be authenticated & owner of the push or the push must have been created with deleteable_by_viewer.

Supported Formats

json

Examples

curl -X DELETE -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fkwjfvhall92.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

GET /r/active.json
Retrieve your active URL pushes.

Returns the list of URL pushes that you previously pushed which are still active.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/active.json
>>>

GET /r/expired.json
Retrieve your expired URL pushes.

Returns the list of URL pushes that you previously pushed which have expired.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/expired.json