# Webhooks

# Check if Webhooks are Enabled

GET /api/v1/flock/settings/webhooks/is_enabled

Check if webhooks are enabled for a Flock.

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id

Response

A JSON structure with the enabled state.

Example

    Response
    {
      "is_enabled": true,
      "result": "success"
    }
    
    1
    2
    3
    4

    # Check if Webhooks are Global

    GET /api/v1/flock/settings/webhooks/is_global

    Check if webhooks are set to Global for a Flock.

    Required Parameters

    auth_token string
    A valid auth token
    flock_id string
    A valid flock_id

    Response

    A JSON structure with the Global state.

    Example

      Response
      {
        "is_global": true,
        "result": "success"
      }
      
      1
      2
      3
      4

      # Disable Flock Webhooks

      POST /api/v1/flock/settings/webhooks/disable

      Disable a Flock's webhooks.

      Required Parameters

      auth_token string
      A valid auth token
      flock_id string
      A valid flock_id

      Response

      A JSON structure with result indicator.

      Example

        Response
        {
          "result": "success"
        }
        
        1
        2
        3

        # Enable Flock Wehooks

        POST /api/v1/flock/settings/webhooks/enable

        Enable a Flock's webhooks.

        Required Parameters

        auth_token string
        A valid auth token
        flock_id string
        A valid flock_id

        Response

        A JSON structure with result indicator.

        Example

          Response
          {
            "result": "success"
          }
          
          1
          2
          3

          # Use Global for Flock Wehooks

          POST /api/v1/flock/settings/webhooks/use_global

          Set the Flock's webhook state to Global.

          Required Parameters

          auth_token string
          A valid auth token
          flock_id string
          A valid flock_id

          Response

          A JSON structure with result indicator.

          Example

            Response
            {
              "result": "success"
            }
            
            1
            2
            3

            # Generic Webhooks

            If you have an endpoint that accepts JSON data, we can setup a webhook to POST all notifications. Simple, but useful.

            # Add Generic Webhook

            POST /api/v1/flock/settings/webhooks/generic/add

            Add a generic webhook to a Flock

            Required Parameters

            auth_token string
            A valid auth token
            flock_id string
            A valid flock_id
            url string
            A valid URL that can accept POSTed data

            Response

            A JSON structure with the result indicator.

            Example

              Response
              {
                "result": "success"
              }
              
              1
              2
              3

              # List Generic Webhooks

              GET /api/v1/flock/settings/webhooks/generic

              Retrieve generic webhooks for a Flock.

              Required Parameters

              auth_token string
              A valid auth token
              flock_id string
              A valid flock_id

              Response

              A JSON structure with the list of generic webhooks.

              Example

                Response
                {
                  "generic_webhooks": [
                    "<webhook_url>",
                    "<webhook_url>"
                  ],
                  "result": "success",
                  "webhooks_enabled": true
                }
                
                1
                2
                3
                4
                5
                6
                7
                8

                # Remove Generic Webhook

                POST /api/v1/flock/settings/webhooks/generic/remove

                Remove a generic webhook from a Flock

                Required Parameters

                auth_token string
                A valid auth token
                flock_id string
                A valid flock_id
                url string
                A valid URL that can accept POSTed data

                Response

                A JSON structure with the result indicator.

                Example

                  Response
                  {
                    "result": "success"
                  }
                  
                  1
                  2
                  3

                  # Test Generic Webhook

                  POST /api/v1/flock/settings/webhooks/generic/test

                  Test a generic webhook for a Flock

                  Required Parameters

                  auth_token string
                  A valid auth token
                  flock_id string
                  A valid flock_id
                  url string
                  A valid URL that can accept POSTed data

                  Response

                  A JSON structure with the result indicator.

                  Example

                    Response
                    {
                      "result": "success",
                      "webhook": "<webhook_url>"
                    }
                    
                    1
                    2
                    3
                    4

                    # MS Teams Webhooks

                    Have an MS Teams account and want us to pipe Flock notifications directly into your channels? Setting up your Flock to do just that is as easy as supplying a valid MS Teams URL.

                    # Add MS Teams Webhook

                    POST /api/v1/flock/settings/webhooks/ms_teams/add

                    Add an MS Teams webhook to a Flock

                    Required Parameters

                    auth_token string
                    A valid auth token
                    flock_id string
                    A valid flock_id
                    url string
                    A valid MS Teams webhook

                    Response

                    A JSON structure with the result indicator.

                    Example

                      Response
                      {
                        "result": "success"
                      }
                      
                      1
                      2
                      3

                      # List MS Teams Webhooks

                      GET /api/v1/flock/settings/webhooks/ms_teams

                      Retrieve MS Teams webhooks for a Flock.

                      Required Parameters

                      auth_token string
                      A valid auth token
                      flock_id string
                      A valid flock_id

                      Response

                      A JSON structure with the list of MS Teams webhooks.

                      Example

                        Response
                        {
                          "ms_teams_webhooks": [
                            "<ms_teams_webhook_url>",
                            "<ms_teams_webhook_url>"
                          ],
                          "result": "success",
                          "webhooks_enabled": true
                        }
                        
                        1
                        2
                        3
                        4
                        5
                        6
                        7
                        8

                        # Remove MS Teams Webhook

                        POST /api/v1/flock/settings/webhooks/ms_teams/remove

                        Remove an MS Teams webhook from a Flock

                        Required Parameters

                        auth_token string
                        A valid auth token
                        flock_id string
                        A valid flock_id
                        url string
                        A valid MS Teams webhook

                        Response

                        A JSON structure with the result indicator.

                        Example

                          Response
                          {
                            "result": "success"
                          }
                          
                          1
                          2
                          3

                          # Test MS Teams Webhook

                          POST /api/v1/flock/settings/webhooks/ms_teams/test

                          Test an MS Teams webhook for a Flock

                          Required Parameters

                          auth_token string
                          A valid auth token
                          flock_id string
                          A valid flock_id
                          url string
                          A valid MS Teams webhook

                          Response

                          A JSON structure with the result indicator.

                          Example

                            Response
                            {
                              "result": "success",
                              "webhook": "<ms_teams_webhook_url>"
                            }
                            
                            1
                            2
                            3
                            4

                            # Slack Webhooks

                            Have an MS Teams account and want us to pipe Flock notifications directly into your channels? Setting up your Flock to do just that is as easy as supplying a valid MS Teams URL.

                            # Add Slack Webhook

                            We currently don't expose the Slack add process via the API directly as it requires a multi-step process which includes Authenticating with Slack and granting permissions for the webhook to POST data to your channels.

                            A step-by-step guide to adding a Slack webhook via the Console UI can be found here.

                            # List Slack Webhooks

                            GET /api/v1/flock/settings/webhooks/slack

                            Retrieve Slack webhooks for a Flock.

                            Required Parameters

                            auth_token string
                            A valid auth token
                            flock_id string
                            A valid flock_id

                            Response

                            A JSON structure with the list of Slack webhooks.

                            Example

                              Response
                              {
                                "result": "success",
                                "slack_webhooks": [
                                  {
                                    "channel": "<channel>",
                                    "configuration_url": "<config_url>",
                                    "team": "<team_name>",
                                    "url": "<slack_webhook_url>"
                                  }
                                ],
                                "webhooks_enabled": true
                              }
                              
                              1
                              2
                              3
                              4
                              5
                              6
                              7
                              8
                              9
                              10
                              11
                              12

                              # Remove Slack Webhook

                              POST /api/v1/flock/settings/webhooks/slack/remove

                              Remove a Slack webhook from a Flock

                              Required Parameters

                              auth_token string
                              A valid auth token
                              flock_id string
                              A valid flock_id
                              team string
                              Slack team tied to the webhook
                              channel string
                              Slack channel tied to the webhook

                              Response

                              A JSON structure with the result indicator.

                              Example

                                Response
                                {
                                  "result": "success"
                                }
                                
                                1
                                2
                                3

                                # Test Slack Webhook

                                POST /api/v1/flock/settings/webhooks/slack/test

                                Test an Slack webhook for a Flock

                                Required Parameters

                                auth_token string
                                A valid auth token
                                flock_id string
                                A valid flock_id
                                url string
                                A valid Slack webhook

                                Response

                                A JSON structure with the result indicator.

                                Example

                                  Response
                                  {
                                    "result": "success",
                                    "webhook": "<slack_webhook_url>"
                                  }
                                  
                                  1
                                  2
                                  3
                                  4