Pushes
Interact directly with pushes.

>>>

GET /p/:url_token.json
Retrieve a 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. If the push has a passphrase, provide it in a ?passphrase=xxx GET parameter.

Supported Formats

json

Examples

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

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

POST /p.json
Create a new push.

Supported Formats

json

Examples

curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken"-F "password[payload]=my_secure_payload"-F "password[files][]=@/path/to/file/file1.extension" -F "password[files][]=@/path/to/file/file2.extension" https://pwpush.com/p.json

Params

Param name Description
password
required

Push details

Validations:

  • Must be a Hash
password[payload]
required

The URL encoded password or secret text to share.

Validations:

  • Must be a String
password[files]
optional

File(s) to upload and attach to the push.

Validations:

  • Must be an array of any type
password[passphrase]
optional

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

Validations:

  • Must be a String
password[note]
optional , blank allowed

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

Validations:

  • Must be a String
password[expire_after_days]
optional

Expire secret link and delete after this many days.

Validations:

  • Must be a Integer
password[expire_after_views]
optional

Expire secret link and delete after this many views.

Validations:

  • Must be a Integer
password[deletable_by_viewer]
optional

Allow users to delete passwords once retrieved.

Validations:

  • Must be one of: true, false.
password[retrieval_step]
optional

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

Validations:

  • Must be one of: true, false.
password[kind]
optional

The kind of push to create. If ‘url’, the generated secret link will 303 redirect the URL in the payload. Defaults to ‘text’.

Validations:

  • Must be one of: text, file, url.
>>>

GET /p/: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/p/fk27vnslkd/preview.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

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

This will return array of views including IP, referrer and other such metadata. 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/p/fk27vnslkd/audit.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

DELETE /p/: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/p/fkwjfvhall92.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

GET /p/active.json
Retrieve your active pushes.

Returns the list of 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/p/active.json
>>>

GET /p/expired.json
Retrieve your expired pushes.

Returns the list of 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/p/expired.json