Integrations

Create an integration

post

Create a new integration for a team. You can find more details on /integrations/available route. Learn more about integrations here.

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Body

application/json

customNamestringOptional

descstringOptional

slugstringOptional

escalationstringOptional

servicestringOptional

repeatEscalationbooleanOptional

ackTimeoutintegerOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

post

/integrations/create

HTTPcURLJavaScriptPython

POST /integrations/create HTTP/1.1
Host: api.spike.sh
x-api-key: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "customName": "string",
  "desc": "string",
  "slug": "string",
  "escalation": "string",
  "service": "string",
  "repeatEscalation": true,
  "ackTimeout": 0
}

{}

Fetch an integration

get

Get Details of a integration

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Path parameters

tokenstringRequired

token parameter

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/integrations/{token}

HTTPcURLJavaScriptPython

GET /integrations/{token} HTTP/1.1
Host: api.spike.sh
x-api-key: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Archive an integration

delete

Archive an integration. Archive integrations will not be shown in the UI

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Path parameters

tokenstringRequired

token parameter

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

delete

/integrations/{token}/archive

HTTPcURLJavaScriptPython

DELETE /integrations/{token}/archive HTTP/1.1
Host: api.spike.sh
x-api-key: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Fetch available integrations on Spike.sh

get

Gets a list of integrations available on Spike

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/integrations/available

HTTPcURLJavaScriptPython

GET /integrations/available HTTP/1.1
Host: api.spike.sh
x-api-key: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}

Fetch all your integrations

get

Get a list of all the integrations for a specific team.

Authorizations

ApiKeyAuth & TeamIdHeader

x-api-keystringRequired

Your API key. You can find this in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/integrations

HTTPcURLJavaScriptPython

GET /integrations HTTP/1.1
Host: api.spike.sh
x-api-key: YOUR_API_KEY
x-team-id: YOUR_TEAM_ID
Accept: */*

{}