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