upstream-zulip/zerver/webhooks/freshstatus/doc.md

Zulip Freshstatus integration

Receive Freshstatus notifications in Zulip!

{start_tabs}

1. {!create-an-incoming-webhook.md!}

2. {!generate-webhook-url-basic.md!}

3. On your Freshstatus dashboard, select Settings and then click Integrations. Under Webhooks, select Manage, and click New Webhook.

4. Set Webhook Name to a name of your choice, such as Zulip, and Description to any suitable description.

5. Under Condition, select the events you'd like to be notified for. Under Action, set Request Type to POST. Set Callback URL to the URL generated above.

6. Leave Requires Authentication untoggled, and set Content to Advanced.

7. Set Incident JSON to the following:

   {
      "id": "{id}",
      "title": "{title}",
      "description": "{description}",
      "start_time": "{start_time}",
      "end_time": "{end_time}",
      "is_private": "{is_private}",
      "source": "{source}",
      "affected_services": "{affected_services}",
      "notification_options": "{notification_options}"
   }
   

8. Set Maintenance JSON to the following:

   {
      "id": "{id}",
      "title": "{title}",
      "description": "{description}",
      "start_time": "{start_time}",
      "end_time": "{end_time}",
      "is_private": "{is_private}",
      "source": "{source}",
      "affected_services": "{affected_services}",
      "notification_options": "{notification_options}",
      "scheduled_start_time": "{scheduled_start_time}",
      "scheduled_end_time": "{scheduled_end_time}",
      "is_auto_update_status_on_scheduled_start": "{is_auto_update_status_on_scheduled_start}",
      "is_auto_update_status_on_scheduled_end": "{is_auto_update_status_on_scheduled_end}",
      "is_auto_update_component_status_on_scheduled_start": "{is_auto_update_component_status_on_scheduled_start}",
      "is_auto_update_component_status_on_scheduled_end": "{is_auto_update_component_status_on_scheduled_end}"
   }
   

9. Set Incident/Maintenance Note JSON to the following:

   {
      "id": "{note_id}",
      "title": "{title}",
      "incident_id": "{note_incident_id}",
      "incident_status": "{note_incident_status}",
      "message": "{note_message}",
      "status": "{note_status}",
      "is_private": "{note_is_private}",
      "notification_options": "{note_notification_options}"
   }
   

10. Click Save. Once the webhook is saved, you can check whether it is configured correctly by clicking Test.

{end_tabs}

{!congrats.md!}

{!event-filtering-additional-feature.md!}

Related documentation

{!webhooks-url-specification.md!}