Getting Started
Special
SINGLE SIGN-ON
Teams
Users
Escalation Policies
Service
Incident
On-Call Shift
Schedules
Schedule Override
API Token
Logs
Webhook
Slack
Reports
Preference
Profile
Automation
FAQ
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.
And we are expecting the API payload to be a json. If the payload is not a json or it doesn’t contains a json key you specified in API Filter, then we will
- Use the title as "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.
We can take an example:
The API endpoint from the API TOKEN tab is: https://****.callgoose.com/v1/test and the API TOKEN is: Fake API Token
The final endpoint can be any of:
https://****.callgoose.com/v1/test – Here we must use the API TOKEN as a Bearer Token while sending API requests.
https://****.callgoose.com/v1/test?from=test – Here we must use the API TOKEN as a Bearer Token while sending API requests. And the from url parameter value will be used if the payload doesn’t contain the specific Incident title key specified in API Filter.
https://****.callgoose.com/v1/test?token=fakeApiToken – The token is used as a Url parameter. No need to use any Authorization header.
https://****.callgoose.com/v1/test?from=test+source&token=fakeApiToken – The token is used as a Url parameter. No need to use any Authorization header. And the from url parameter value will be used if the payload doesn’t contain the specific Incident title key specified in API Filter.
