API Endpoints

It’s possible to trigger notifications generation using the following endpoints:


Raw notifications

Generates notifications with the title/content provided in the request.

GET/POST/PUT https://hook.notify17.net/api/raw/{RAW_API_KEY}
VariableTypeNotes
titlestring, requiredNotification title
contentstringNotification content

Supported content types:

  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data

Sample requests:

curl -X POST \
  "https://hook.notify17.net/api/raw/RAW_API_KEY" \
  -F title="Instance setup: finished" \
  -F content="Instance ${HOSTNAME} has been set up correctly!"
curl "https://hook.notify17.net/api/raw/RAW_API_KEY?title=Instance%20setup%20completed"

Templated notifications

Generates notifications starting from notification templates, filling them with the request entire body content.

GET/POST/PUT https://hook.notify17.net/api/template/{TEMPLATE_API_KEY}
VariableTypeNotes
All arguments*Template arguments

Supported content types:

  • application/json (accepts only JSON objects, not plain arrays)
  • application/x-www-form-urlencoded
  • multipart/form-data

Sample requests:

curl -X POST \
  "https://hook.notify17.net/api/template/TEMPLATE_API_KEY" \
  -F hostname="10.0.1.2"
curl "https://hook.notify17.net/api/template/TEMPLATE_API_KEY?hostname=10.0.1.2"

Raw templated notifications

Generates notifications starting from:

  • A title/content templates pair provided with the request.
  • The templates’ arguments, composed by the rest of the request body.

    GET/POST/PUT https://hook.notify17.net/api/rawTemplated/{RAW_API_KEY}
VariableTypeNotes
__n17TitleTemplatestring, requiredNotification title template
__n17ContentTemplatestringNotification content template
__n17TriggerConditionstringTrigger condition for the template
Every other argument*Template arguments

Supported content types:

  • application/json
  • application/x-www-form-urlencoded
  • multipart/form-data

Sample requests:

curl -X POST \
  "https://hook.notify17.net/api/rawTemplated/RAW_API_KEY" \
  -F __n17TitleTemplate="Instance setup: finished" \
  -F __n17ContentTemplate="Instance {{ .hostname }} has been set up!" \
  -F hostname="10.0.1.2"