API Key
Mint a key for your scripts, apps, or integrations.
What it does
The Prowl API receives notifications addressed to one or more API keys and delivers them to all of your configured Destinations. This Source is the most versatile: you can send notifications to Prowl through integrations you write, or in other applications which have added support for Prowl.
Before you start
There are no prerequisites to creating an API Key.
Set it up
After you add an API Key to your Sources, you'll find a randomly generated key on the Source's page. You can copy this key and paste it where you need it.
Send a notification with the API
The Prowl API documentation has specifics on the fields and what you can do, but briefly use your language of choice's HTTP library to send a JSON request:
curl https://api.prowl.app/2/add --json '{
"apikeys": ["0123456789abcdef0123456789abcdef01234567"],
"application": "deploy.sh",
"event": "Deploy finished",
"description": "web @ a17f2c took 38s",
"url": "https://example.com/deploys/42",
"priority": "normal"
}'
When writing an API call in a script, you might find the endpoint's support for URL-encoded or multipart forms easier to integrate, for example:
curl https://api.prowl.app/2/add \
-F 'apikeys[]=0123456789abcdef0123456789abcdef01234567' \
-F 'application=deploy.sh' \
-F 'event=Deploy finished' \
-F 'description=web @ a17f2c took 38s' \
-F 'url=https://example.com/deploys/42' \
-F 'priority=normal'
Legacy Prowlmail compatibility
You might have an email address ending in @api.prowlapp.com for your prior API Keys. Those will continue to work, but you should migrate to using an Email Source which allows for greater configuration and a nicer email address.
Troubleshooting
My key is rejected as invalid
An API Key is 40 characters long containing only lowercase hexadecimal characters, such as 0123456789abcdef0123456789abcdef01234567. Make sure you've copied the full key when pasting it somewhere.
My requests are rejected or rate-limited
Check the HTTP response code to the API requests you're invoking, and verify the response doesn't include any errors.
Requests succeed but nothing arrives
If your API Key is paused, or you've reached your daily notification limit, the API Key add request will still succeed, but the notification won't be delivered. Prowl will notify you when you reach your daily notification limit.
Disconnect or replace it
Add a new key, replace existing uses of the old one, then delete the old one. You cannot rotate an API Key's value as it has no configuration, but you can pause or remove it at any time.