Skip to main content

Create an ServiceNow endpoint

POST 

https://api.logz.io/v1/endpoints/service-now

Creates a new ServiceNow notification endpoint or sends a test message to ServiceNow. Please ensure to change the region in the URL to match your account's region.

Request

Query Parameters

    test boolean

    To send a test message to the endpoint, true. Otherwise, false.

    Note: If set to true, the notification endpoint is not created. To create the endpoint, you need to send the API request where test=false.

Body

    title string

    Name of the endpoint

    description string

    Detailed description of the endpoint

    username string

    ServiceNow user name

    password string

    ServiceNow password

    url string

    Provide your instance URL to connect to your existing ServiceNow instance, i.e. https://xxxxxxxxx.service-now.com/.

Responses

successful operation

Schema
    id int32

    ID of the notification endpoint. If the API call was made where test=true, then no changes are made to the endpoint. In this case, the response body contains {"id": -1} to indicate that a test message was sent.

Authorization: X-API-TOKEN

name: X-API-TOKENtype: apiKeydescription: You can manage your API tokens from the [Logz.io API tokens](https://app.logz.io/#/dashboard/settings/manage-tokens/api) page.

API tokens are account-specific. You will need to be logged into the relevant Log Management or SIEM account to view the API tokens associated with it.

To manage your API tokens, log into the relevant account in your Logz.io platform, click the gear in the top-right menu, and select [**Tools > Manage tokens > API tokens**](https://app.logz.io/#/dashboard/settings/manage-tokens/api).

It's important to keep your tokens secure. API tokens carry privileges to make changes to users and accounts, so if you believe an API token has been compromised, delete it, and replace it with a new token in your integrations.in: header
curl -L -X POST 'https://api.logz.io/v1/endpoints/service-now' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>' \
--data-raw '{
"title": "New ServiceNow endpoint",
"description": "Sends notifications to logzio-alerts channel",
"username": "User",
"password": "Password",
"url": "https://my.custom-endpoint.com"
}'
Request Collapse all
Base URL
https://api.logz.io
Auth
Parameters
— query
Body
{
  "title": "New ServiceNow endpoint",
  "description": "Sends notifications to logzio-alerts channel",
  "username": "User",
  "password": "Password",
  "url": "https://my.custom-endpoint.com"
}