Notifications
High-resolution downloads are generated asynchronously. Instead of polling for a file to become ready, you can register a URL to receive a notification once it is done.
Register a notification URL
Call /settings/set-notification-url with your API key, application name, developer name and email, and the URL you want notifications sent to:
GET /settings/set-notification-url?client_id={api_key}&app_name={app_name}&name={your_name}&email={your_email}&url={your_url}When you register a URL, PosterMyWall sends it a notification with notification_type: "url_registration" to confirm the registration. If your URL responds with HTTP 200, the registration is saved.
Possible error codes: invalid_api_key, invalid_url.
Notification types
Once a URL is registered, PosterMyWall sends a notification to it whenever one of the following happens:
| notification_type | Sent when |
|---|---|
new-download |
An OAuth user orders a new download |
download-regenerated |
A user modifies an existing order |
download-endpoint |
A design becomes ready after /users/{user_id}/designs/{design_id}/download is called |
Every notification includes a request_id that matches the request_id returned by the API call that triggered it, so you can tell which notification belongs to which request. See the Notification schema in the API Reference for the full payload.
Send a test notification
To confirm your endpoint is wired up correctly, call /settings/test-notification with the same developer details, plus an optional type (new-download or download-regenerated; defaults to new-download):
GET /settings/test-notification?client_id={api_key}&app_name={app_name}&name={your_name}&email={your_email}&type=new-downloadPossible error codes: invalid_api_key, missing_notification_url, invalid_notification_url.
Unsubscribe
To stop receiving notifications, call /settings/unset-notification-url with your API key and developer details.
Possible error codes: invalid_api_key.