Spok
The Spok connector facilitates critical communications by integrating Spok's messaging services with Swimlane's automation capabilities.
Spok delivers critical communications solutions for healthcare, government, and other industries requiring on-call management and secure messaging. The Spok Turbine Connector enables seamless integration with Spok services, allowing users to automate the retrieval of on-call group assignments, current roles, messaging IDs, and the sending of pages directly from the Swimlane platform. By leveraging this connector, Swimlane Turbine users can enhance their incident response capabilities, streamline communication workflows, and ensure timely notifications and escalations within their security operations.
Limitations
None to date.
Supported Versions
This connector supports the latest version of the Spok API.
Additional Docs
Configuration
Prerequisites
To utilize the Spok connector within the Swimlane platform, ensure you have the following prerequisites:
- Custom authentication credentials with the following parameters:
- Username: The Spok account username.
- Password: The corresponding password for the Spok account.
- Primary IP: The primary IP address of the Spok server.
- Port: The port number used to connect to the Spok server.
Authentication Methods
- Spok credentials authentication with the following parameters:
- Username: The Spok account username.
- Password: The corresponding password for the Spok account.
- Primary IP: The primary IP address of the Spok server.
- Port: The port number used to connect to the Spok server.
Capabilities
This Connector provides the following capabilities:
- Get Groups Assignments XML
- Get Groups Current Assignments XML
- Get Listing Info by MID
- Get Messaging ID
- Send Page
Get Groups Assignments XML
- This action retrieves all assignments and roles of a given on-call group.
Get Groups Current Assignments XML
- This action retrieves current assignments and roles of a given on-call group.
Get Listing Info by MID
- This action searches the listing table for the matching record based on the 1st parameter for messaging ID. Thereturned information contains the data for the listing record.
Get Messaging ID
- This action retrieves the messaging ID for a given SSO user name.
Send Page
- This action sends a page to a messaging ID and determines the final covering ID and finds a destination pager. Thisprocedure also queues the page in the queued_page table to be picked up by the paging process.
Configurations
Spok Authentication
Authenticates using Spok credentials.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
Username | The username for authentication. | string | Required |
Password | The password for authentication. | string | Required |
primary_ip | The primary IP address for authentication. | string | Required |
secondary_ip | The secondary IP address for authentication. | string | Optional |
port | The port for authentication. | integer | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Get Groups Assignments XML
Retrieve all roles and assignments for a specific on-call group in Spok, with required parameters ocmid, ocastart, ocmend, and tz.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
ocmid | string | Required | The on-call group messaging ID. |
ocastart | string | Required | The on-call start time. |
ocmend | string | Required | The on-call end time. |
auth_needed | boolean | Optional | Indicates whether authentication is needed. |
Input Example
{"ocmid":"test","ocastart":"2023-10-01T00:00:00Z","ocmend":"2023-10-31T23:59:59Z"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Groups Current Assignments XML
Retrieve current roles and assignments for a specified on-call group in Spok, with 'ocmid' as a required input.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
ocmid | string | Required | The on-call group messaging ID. |
auth_needed | boolean | Optional | Indicates whether authentication is needed. |
Input Example
{"ocmid":"1234"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Listing Info by MID
Retrieves data from Spok's listing table for a record matching the provided messaging ID.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
mid | string | Required | The messaging ID to use in determining the correct record to pull information. |
auth_needed | boolean | Optional | Indicates whether authentication is needed. |
Input Example
{"mid":"1234567890"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Messaging ID
Retrieves the messaging ID associated with a specified SSO username in the Spok system, requiring an SSO username as input.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
sso_username | string | Required | The SSO user name of the user whose messaging ID is to be returned. |
auth_needed | boolean | Optional | Indicates whether authentication is needed. |
Input Example
{"sso_username":"testuser"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Send Page
Sends a page with specified text and priority to a messaging ID, queues it for processing, and identifies the destination pager.
Endpoint
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
mid | string | Required | Destination messaging ID. |
paged_text | string | Required | Text to send to pager. |
priority | number | Required | Page priority. The range of supported value is 0 through 999 where 0 is the lowest while 999 is the highest priority. |
auth_needed | boolean | Optional | Indicates whether authentication is needed. |
Input Example
{"mid":"send_page","paged_text":"Send Page","priority":1}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |