Register Webhooks For Notifications
Description
This route is used to add webhook URLs which we call each time a new imagery update is available. You can register multiple URLs.
Endpoints
- /notifications/register_webhook
Method type
POST
Parameters
name | description | type | Required | Default Value |
---|---|---|---|---|
token | Your identification token | string | required | |
url | Webhook URL | string | required |
Responses
status code | description |
---|---|
200 | The request has succeeded |
403 | Forbidden request |
500 | Unexpected error |
Notification example
{
"group": "farm-260",
"field": "14853",
"data": [
{
"index": "ndvi",
"date": "2020-04-24 00:00:00 GMT",
"content": {
"mean": 0.609,
"mean_variation": 18.02,
"median": 0.592,
"std": 0.099,
"min": 0.466,
"max": 0.842,
"p25": 0.525,
"p75": 0.68
}
}
]
}
Example Request
POST https://spacesense-api.ew.r.appspot.com/notifications/register_webhook?token=__myToken__&url=__myURL__
Example Response
{
"message": "Webhook __myURL__ is registered",
"username": "__userName__"
}