Instatus Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Instatus location.

Instatus

1. Click the + icon on the Nexset that will be sent to the Instatus destination, and select the Send to Destination option from the menu.

2. Select the Instatus connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Instatus organization, and click Next; or, create a new Instatus credential for use in this flow.

3. In Nexla, Instatus destinations can be created using pre-built endpoint templates, which expedite destination setup for common Instatus write operations. Each template is designed specifically for the corresponding Instatus endpoint, making destination setup easy and efficient.
   • To configure this destination using a template, follow the instructions in Configure Using a Template.

   Instatus destinations can also be configured manually, allowing you to send data to any valid Instatus API endpoint — including creating incidents, updating component statuses, posting maintenance windows, or adding subscribers.
   • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Instatus endpoints. Each template is designed specifically for the corresponding Instatus endpoint, making destination setup easy and efficient.

Endpoint Settings

• Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.

  Create Status Page

  Creates a new Instatus status page with specified configuration, branding, and notification settings. Use this endpoint to automate the provisioning of status pages from a data-driven workflow.

  • Issues a POST request to the Instatus pages API. The request body accepts page name, subdomain, component definitions, branding colors, notification settings, and custom HTML/CSS.
  • Required fields include Email, Page Name, and Subdomain. All other parameters are optional configuration.

  The subdomain must be unique across Instatus. Ensure that the subdomain values in your Nexset do not conflict with existing pages before running this destination at scale.

  Update Status Page

  Updates an existing Instatus status page with new configuration, branding, or notification settings. Use this endpoint to programmatically apply changes to page settings from a Nexla data flow.

  • Issues a PUT request to the Instatus page endpoint. The Page ID parameter must be configured to identify which page to update.
  • Accepts all page configuration fields — only the fields included in the request body will be updated.

  Use the Exclude Attributes option to omit any Nexset fields that are not valid Instatus page parameters, preventing API errors from unrecognized fields.

  Create Component

  Creates a new component on a specified Instatus status page. Use this endpoint to programmatically add service components to a status page from a Nexset of component definitions.

  • Issues a POST request to the components endpoint for the specified page. Configure the Id (page ID) parameter along with component name, description, status, and display settings.
  • Supported component status values include operational, degraded_performance, partial_outage, major_outage, and under_maintenance.

  Components must be associated with a page. Ensure the Page ID parameter is set correctly, and that the component status value matches one of the accepted Instatus status strings.

  Update Component

  Updates the configuration and status of a specific component on a status page. Use this endpoint to automate component status updates — for example, changing a component to degraded or operational based on monitoring data flowing through Nexla.

  • Issues a PUT request to the specific component endpoint. Configure both the Id (page ID) and Component Id parameters to identify which component to update.
  • Only the fields included in the request body will be changed on the component record.

  This is one of the most common Instatus destination patterns — feeding monitoring or alerting data into Nexla and using this endpoint to keep component statuses on your status page current in real time.

  Add an Incident

  Creates a new incident on the specified status page. Use this endpoint to automatically open incidents from alerting or monitoring data flowing through Nexla.

  • Issues a POST request to the incidents endpoint. Configure the Page Id parameter along with incident name, message, affected components, start time, and status.
  • Required fields include Page Id, Incident Name, and Message. Use the Notify parameter to control whether subscribers receive a notification.

  Set the Status parameter to INVESTIGATING, IDENTIFIED, MONITORING, or RESOLVED to control the initial incident state. Use the Response Webhook option to capture the newly created incident ID for subsequent update operations.

  Update Incident

  Updates an existing incident with new details, status, or affected component information. Use this endpoint to progress an incident through its lifecycle from a Nexla data flow.

  • Issues a PUT request to the specific incident endpoint. Configure the Page Id and Incident Id parameters to identify the incident to update.
  • Accepts updated incident name, components, status, and notification flag. Only the supplied fields are updated.

  Pair this endpoint with the Add an Incident Update endpoint to both update incident metadata and post a visible status message update at the same time.

  Add an Incident with a Template

  Creates a new incident using a predefined template for consistent, standardized incident creation. Use this endpoint when incident communications should follow a pre-approved template format.

  • Issues a POST request to the incidents endpoint using a template ID. Configure the Page Id parameter along with the template ID to use.
  • The template defines the incident message and structure — reducing the data fields required in the request body compared to a manual incident creation.

  Use the List Templates source endpoint to retrieve available template IDs before configuring this destination. Templates ensure consistent incident communication standards across your team.

  Add an Incident Update

  Posts a new status update to an existing incident. Use this endpoint to automatically publish progress updates to an incident timeline from a Nexla data flow.

  • Issues a POST request to the incident updates endpoint. Configure the Page Id and Incident Id parameters along with the update message, status, and notification settings.
  • Each call creates a new timeline entry on the incident visible to subscribers and status page visitors.

  Use the Notify parameter to control whether subscribers receive an email/SMS notification for each update. For high-frequency updates, consider setting Notify to false to avoid subscriber notification fatigue.

  Create a Maintenance

  Creates a new scheduled maintenance event on a status page. Use this endpoint to automate the creation of maintenance windows from change management or ITSM data flowing through Nexla.

  • Issues a POST request to the maintenances endpoint. Configure the Page Id parameter along with maintenance name, message, start/end times, affected components, and notification settings.
  • Supports auto-start and auto-end flags to automatically transition maintenance status at the scheduled start and end times.

  Use the Notifystart and Notifyend parameters to control when subscriber notifications are sent. Set Auto-start and Auto-end to true to have Instatus automatically manage maintenance status transitions.

  Update a Maintenance

  Updates an existing maintenance event on a status page. Use this endpoint to modify maintenance window details, extend duration, or update affected components from a Nexla data flow.

  • Issues a PUT request to the specific maintenance endpoint. Configure both the Page Id and Maintenance Id parameters.
  • Accepts updated name, message, start/end times, status, and notification settings.

  Use the Response Webhook option on the Create a Maintenance destination to capture maintenance IDs, which can then be used as input to this endpoint for subsequent updates in the same data flow.

  Add a Metric

  Creates a new metric on a status page. Use this endpoint to define a new uptime or performance metric that can track and display operational data on the status page.

  • Issues a POST request to the metrics endpoint. Configure the Page Id parameter along with the metric name and suffix (unit label, e.g., "ms" or "%").
  • After creation, use the Add Multiple Datapoints endpoint to populate the metric with data values.

  Metrics must be created before datapoints can be added. Use this endpoint to provision new metrics, then use the Add Multiple Datapoints endpoint to write historical or real-time performance data.

  Add Multiple Datapoints to a Metric

  Adds multiple datapoints to an existing metric in a single request. Use this endpoint to bulk-upload performance or uptime data from Nexla into a status page metric.

  • Issues a POST request to the metric datapoints endpoint. Configure the Page Id and Metric Id parameters along with the Data array of timestamp/value pairs.
  • Each datapoint in the Data array should include a timestamp and a numeric value.

  This endpoint accepts an array of datapoints per request, making it efficient for backfilling historical metric data or writing batches of recent observations from a monitoring pipeline.

  Create a Monitor

  Creates a new uptime monitor on a status page to track the availability and performance of a specified URL or endpoint. Use this endpoint to automate monitor provisioning from a list of services or URLs.

  • Issues a POST request to the monitors endpoint. Configure the Page ID parameter along with the URL to monitor and optional basic authentication credentials.
  • The monitor will periodically check the specified URL and report its availability on the status page.

  Instatus monitors can check HTTP/HTTPS endpoints for availability. Provide the Basic Authentication parameter if the monitored endpoint requires credentials, in the format username:password.

  Create a Workspace

  Creates a new Instatus workspace with customizable notification and reporting settings. Use this endpoint to automate workspace provisioning as part of a multi-tenant or onboarding workflow.

  • Issues a POST request to the workspaces endpoint. Required fields include Workspace Name and Workspace Slug (unique identifier).
  • Optional settings control notification preferences for status updates, automation alerts, domain notifications, phone notifications, and weekly reports.

  The workspace slug must be globally unique within Instatus. Verify slug values in your Nexset before running this destination to avoid creation failures from slug conflicts.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can send a test payload to the Instatus API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Instatus API using the current settings.

Configure Manually

Instatus destinations can be manually configured to send data to any valid Instatus API endpoint. This is useful for automating status page updates — such as creating incidents, updating component statuses, posting maintenance windows, or adding subscribers — directly from Nexla data flows.

First, select the API method that will be used for calls to the Instatus API from the Method pulldown menu.

The Instatus API uses the following HTTP methods:

• POST: For creating new resources (incidents, components, maintenances, subscribers, etc.)
• PUT: For fully updating an existing resource
• DELETE: For removing a resource (incidents, subscribers, team members, etc.)
• PATCH: For partial updates where supported

Data Format

4. Select the format in which the Nexset data will be sent to the Instatus API from the Content Format pulldown menu. The Instatus API requires all request bodies to be formatted as JSON — select JSON from the pulldown menu. Nexla will automatically convert the Nexset data to JSON for each API call.

API Endpoint URL

5. Enter the URL of the Instatus API endpoint to which you want to send the Nexset data in the URL field. The Instatus API base URL is https://api.instatus.com. Common destination endpoints include:

   • Create an incident: https://api.instatus.com/v1/{page_id}/incidents
   • Update an incident: https://api.instatus.com/v1/{page_id}/incidents/{incident_id}
   • Add an incident update: https://api.instatus.com/v1/{page_id}/incidents/{incident_id}/incident-updates
   • Create a maintenance: https://api.instatus.com/v1/{page_id}/maintenances
   • Update a component: https://api.instatus.com/v1/{page_id}/components/{component_id}
   • Add a subscriber: https://api.instatus.com/v1/{page_id}/subscribers
   • Add multiple subscribers (bulk): https://api.instatus.com/v1/{page_id}/subscribers/bulk (maximum 100 per call)
   • Add a metric datapoint: https://api.instatus.com/v1/{page_id}/metrics/{metric_id}

   Replace {page_id}, {incident_id}, {component_id}, and {metric_id} in the above URLs with the IDs of the corresponding Instatus resources. You can retrieve these IDs using an Instatus data source configured with the appropriate GET endpoint.

For update and delete operations, make sure to include the specific resource ID at the end of the URL (e.g., https://api.instatus.com/v1/{page_id}/incidents/{incident_id}). The Instatus API uses the resource ID in the URL path to identify which resource to modify or remove.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

  You do not need to include the Authorization or Content-Type headers here — these are automatically handled by Nexla based on your Instatus credential and the selected data format.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this Instatus destination, select the attributes from the Exclude Attributes pulldown menu. This is useful when your Nexset contains fields that are not accepted by the Instatus API endpoint — for example, internal Nexla metadata fields or source-system fields not relevant to the Instatus request payload.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

   The Instatus bulk subscribers endpoint (/subscribers/bulk) supports a maximum of 100 subscribers per call. When using record batching with subscriber data, set the Batch Size to 100 or fewer to comply with this limit.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook

Optional

Nexla can automatically send the response received from the Instatus API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned — such as the newly created incident ID, updated component status, or confirmation of subscriber addition.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the Instatus API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing

After all endpoint settings have been configured, Nexla can send a test payload to the Instatus API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Instatus API using the current settings.

Save & Activate the Destination

• Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Instatus endpoint, open the destination resource menu, and select Activate.

  The Nexset data will not be sent to the Instatus API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.