logo

CALLGOOSE

API END POINT

API end point is the url which is used to send API calls. You can also refer it as WEBHOOK Endpoint.


What is my final API End point

The API endpoint from the API TOKEN tab is the base url without any url parameters. The final URL may be varied based on the caller and how they send api token(By using as a Bearer Token or as a URL Parameter)


Bearer Token

If the caller support Authorization header then you can use the API TOKEN as a Bearer token. Here, we don’t need to alter the the API ENDPOINT for API TOKEN.


URL parameter

If the caller doesn’t support header customization, then we can use API TOKEN as a value of URL parameter named token. Here the API ENDPOINT need to be change.


We are expecting the API payload to be a json.


How we create Incident

The Incident title and description will be created from the API payload and from URL parameter.


Incident Title

If the payload contains json key "Incident title from" specified in API Filter, we will create Incident with title

  • '<value of 'from URL parameter'> - <value of 'Incident title from' key>'
  • If there is no from URL parameter, then we will use title as: '<value of 'Incident title from' key>'

If the payload is not a json or it doesn’t contains "Incident title from" key you specified in API Filter, then we will create incident with title

  • 'Incident from <value of from URL parameter>' in your preferred language.
  • If there is no from URL parameter, then we will use title as 'Incident from unknown source' in your preferred language.


Incident Description

If the payload contains json key "Incident description from" specified in API Filter, we will create Incident with description as the value of the "Incident description from" key.

In all other cases, we will use API payload as the Incident description.



API Endpoint. General example:

Consider the API Base URL from the API TOKEN tab is: https://****.callgoose.com/v1/process and the API TOKEN is: xxxx


The final endpoint can be any of:

https://****.callgoose.com/v1/process – Here we must use the API TOKEN as a Bearer Token while sending API requests. And because there is no from URL parameter, we may use 'Incident from unspecified source' in your preferred language to create Incident title, or use the specific 'Incident title key' specified in API Filter.

https://****.callgoose.com/v1/process?from=FromValue – Here we must use the API TOKEN as a Bearer Token while sending API requests. And the from URL parameter value will be used as a part of Incident title with specific Incident title key specified in API Filter.

https://****.callgoose.com/v1/process?token=xxxx – The token is used as a Url parameter. No need to use any Authorization header. And because there is no from URL parameter, we may use 'Incident from unspecified source' in your preferred language to create Incident title, or use the specific 'Incident title key' specified in API Filter.

https://****.callgoose.com/v1/process?from=FromValue&token=xxxx – The token is used as a Url parameter. No need to use any Authorization header. And the from URL parameter value will be used as a part of Incident title with specific Incident title key specified in API Filter.



API Endpoint. Eg: Prometheus

Consider the API Base URL from the API TOKEN tab is: https://****.callgoose.com/v1/process and the API TOKEN is: xxxx

Use the following URLs:


https://****.callgoose.com/v1/process?from=Prometheus – Here we must use the API TOKEN as a Bearer Token while sending API requests. And the from URL parameter value Prometheus will be used as a part of Incident title with specific Incident title key specified in API Filter.
Here, Incident title will be: 'Prometheus - <value of 'Incident title from' key>'.
And if there is no 'Incident title from' key, then the Incident title will be 'Incident from Prometheus'

https://****.callgoose.com/v1/process?from=Prometheus&token=xxxx – The token is used as a Url parameter. No need to use any Authorization header. And the from URL parameter value Prometheus will be used as a part of Incident title with specific Incident title key specified in API Filter.
Here, Incident title will be: 'Prometheus - <value of 'Incident title from' key>'.
And if there is no 'Incident title from' key, then the Incident title will be 'Incident from Prometheus'

CALLGOOSE
SQIBS

Advanced Automation platform with effective On-Call schedule, real-time Incident Management and Incident Response capabilities that keep your organization more resilient, reliable, and always on

Callgoose SQIBS can Integrate with any applications or tools you use. It can be monitoring, ticketing, ITSM, log management, error tracking, ChatOps, collaboration tools or any applications

Callgoose providing the Plans with Unique features and advanced features for every business needs at the most affordable price.



Unique Features

  • 30+ languages supported
  • IVR for Phone call notifications
  • Dedicated caller id
  • Advanced API & Email filter
  • Tag based maintenance mode

Signup for a freemium plan today &
Experience the results.

No credit card required