Rest Integration

What it does

This skill enables AI agents to interact with REST APIs within ServiceNow environments, facilitating both outbound calls to external services and inbound handling of requests. It leverages ServiceNow's RESTMessageV2 class for making API calls and provides examples for common operations like GET, POST, and authentication methods. The skill focuses on integrating REST API interactions as part of agent workflows within the ServiceNow platform.

When to use it

• Automating data retrieval from external APIs (e.g., fetching user information from a directory service).
• Creating new records in external systems via API calls (e.g., submitting incidents to an external ticketing system).
• Integrating with third-party services that expose RESTful endpoints.
• Reusing pre-defined REST Message records for consistent and repeatable integrations within ServiceNow.

Key capabilities

• GET Requests: Retrieves data from a specified endpoint.
• POST Requests: Sends data to an endpoint, often used for creating new resources.
• JSON Body Support: Allows sending JSON formatted payloads in POST requests.
• HTTP Status Code Handling: Checks the HTTP status code of responses (e.g., 200 OK).
• Basic Authentication: Supports authentication using a username and password.
• Bearer Token Authentication: Supports authentication using a bearer token.
• OAuth 2.0 Integration: Supports OAuth 2.0 authentication through the use of predefined OAuth profiles within ServiceNow.
• REST Message Records: Allows for defining and reusing REST API configurations in ServiceNow.

Example prompts

• "Make a GET request to https://api.example.com/users."
• "Create a new incident at https://api.example.com/incidents with title 'New Incident' and description 'Created from ServiceNow'."
• "Execute the REST Message record named 'External API - Create User' using userName 'testuser' and email '[email protected]'."

Tips & gotchas

• This skill requires a working ServiceNow environment with appropriate permissions to use RESTMessageV2.
• The examples provided are snippets of code; they need to be adapted and integrated into larger ServiceNow workflows or scripts.
• Ensure that the API endpoints and authentication credentials used in your requests are correct and secure.