Create an alert
Create an alert that watches a single entity and emails the configured address whenever the entity is mentioned on a podcast episode. To cover several entities, create one alert per entity. Alerts are not covered by zero data retention: the alert's definition and its matched results are stored as part of the alerts feature.
Request
- Base URL: https://api.particle.pro
- URL: https://api.particle.pro/v1/projects/{projectId}/alerts
- Auth: one of:
- API key in header X-API-Key
- HTTP bearer
Path parameters
Project ID.
Headers
A key you choose, such as a UUID, to retry this request safely. Resend the same key with the same request and the first response is returned with Idempotent-Replayed: true instead of the request running again, for 24 hours after it succeeded. The same key with a different request returns 422 idempotency_key_reused; a retry while the first request is still running returns 409 idempotency_key_in_use. A request that fails does not use up its key.
Request body
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.