Integrating with Webhooks

Use spike's webhook and create an incident from your code.

Create an incident using our webhooks integration

Each webhook is unique to the service and escalation policy. Make sure you create a webhook integration and copy the webhook url. Know how.

From your code, you can create an incident simply by making a POST request.

post
Create an incident

https://hooks.spike.sh/:token/push-events
Request
Response
Request
Path Parameters
token
required
string
Unique token for your webhook integration
Form Data Parameters
body
optional
string
As of now, you can add any message about the incident you would like here. Accepts objects too.
title
optional
string
This will be the title of your incident. Failing to add this will create an empty incident title with all other parameters. Read more about this below 👇
Response
200: OK
Cake successfully retrieved.
{ Ok: true }
500: Internal Server Error
Could not process your request.
{}

The above request will create a new incident. Please make sure you have used the correct webhook URL. If you have copied the URL from the dashboard then the token should already be present. A new incident is created soon as make a POST request. A successful request will get you 200 HTTP response status code.

When is a new incident NOT created?

If the integration has an open incident (not resolved state) with the same title then a new incident will NOT be created.

What is the title's significance?

The title plays an important role really. A new incident will use this title and it will be sent on all alter channels. The title acts as a unique identifier to perform group actions, suppress repeated incidents and also to auto-resolve them.

What happens if I miss adding a title?

Failing to add title would create incidents with no message. This also means that it will NOT group, suppress or auto-resolve these incidents.

We highly recommend you add a title to your POST request while creating an incident

post
Auto-resolve incident

https://hooks.spike.sh/:token/push-events
Request
Response
Request
Path Parameters
token
required
string
Unique token for your webhook integration
Form Data Parameters
status
required
string
resolve
body
optional
string
As of now, you can add any message about the incident you would like here. Accepts objects too.
title
optional
string
This will be the title of your incident. Failing to add this will create an empty incident title with all other parameters. Read more about this below 👇
Response
200: OK
Cake successfully retrieved.
{ Ok: true }
500: Internal Server Error
Could not process your request.
{}

The above request will automatically resolve incidents. We use the title and the token to uniquely get open incidents and resolve them.

All you need is to add the status parameter as 'resolve' in your POST request. The rest of the parameters are the same as creating incident request.

Make sure to have the same title while resolving, otherwise it won't work. Failing to add title will not resolve or create new incident.