Global Event Rules

List Global Event Rules

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/global-event-rules

Get a list of all GERs

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

owner_idstringRequired

page_sizeintegerOptional

page_numberintegerOptional

filters.owner_id[]string[]Optional

filters.searchstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/global-event-rules

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.GlobalEventRules.List(ctx, operations.GlobalEventRulesListGlobalEventRulesRequest{
        OwnerID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "data": [
    {
      "id": 1,
      "org_id": "text",
      "team_id": "text",
      "name": "text",
      "description": "text",
      "routing_key": "text",
      "entity_owner": {
        "id": "text",
        "type": "team"
      },
      "rulesets": [
        {
          "id": 1,
          "global_event_rule_id": 1,
          "alert_source_shortname": "text",
          "alert_source_version": "text",
          "ordering": [
            1
          ],
          "catch_all_action": {
            "route_to": "text"
          },
          "created_at": "2026-03-18T06:41:30.407Z",
          "created_by": "text",
          "updated_at": "2026-03-18T06:41:30.407Z",
          "updated_by": "text"
        }
      ],
      "created_at": "2026-03-18T06:41:30.407Z",
      "created_by": "text",
      "updated_at": "2026-03-18T06:41:30.407Z",
      "updated_by": "text"
    }
  ],
  "meta": {
    "total_count": 1
  }
}

Create Global Event Rule

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/global-event-rules

Create a GER

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

descriptionstringRequired

owner_idstringRequired

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/global-event-rules

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.GlobalEventRules.Create(ctx, components.V3GlobalEventRulesCreateGlobalEventRuleRequest{
        Name: "<value>",
        Description: "majestically effector headline dampen eek middle like shrill",
        OwnerID: "<id>",
        EntityOwner: components.V3GlobalEventRulesEntityOwner{
            ID: "<id>",
            Type: components.V3GlobalEventRulesEntityOwnerTypeUser,
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "owner_id": "text",
    "name": "text",
    "description": "text",
    "routing_key": "text",
    "entity_owner": {
      "id": "text",
      "type": "team"
    },
    "rulesets": [
      {
        "id": 1,
        "global_event_rule_id": 1,
        "alert_source_shortname": "text",
        "alert_source_version": "text",
        "ordering": [
          1
        ],
        "catch_all_action": {
          "route_to": "text"
        },
        "created_at": "2026-03-18T06:41:30.407Z",
        "created_by": "text",
        "updated_at": "2026-03-18T06:41:30.407Z",
        "updated_by": "text"
      }
    ],
    "created_at": "2026-03-18T06:41:30.407Z",
    "created_by": "text",
    "updated_at": "2026-03-18T06:41:30.407Z",
    "updated_by": "text"
  }
}

Get Global Event Rule by ID

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/global-event-rules/{ger_id}

Get a GER by its ID

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/global-event-rules/{ger_id}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.GlobalEventRules.GetByID(ctx, 292040)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "owner_id": "text",
    "name": "text",
    "description": "text",
    "routing_key": "text",
    "entity_owner": {
      "id": "text",
      "type": "team"
    },
    "rulesets": [
      {
        "id": 1,
        "global_event_rule_id": 1,
        "alert_source_shortname": "text",
        "alert_source_version": "text",
        "ordering": [
          1
        ],
        "catch_all_action": {
          "route_to": "text"
        },
        "created_at": "2026-03-18T06:41:30.407Z",
        "created_by": "text",
        "updated_at": "2026-03-18T06:41:30.407Z",
        "updated_by": "text"
      }
    ],
    "created_at": "2026-03-18T06:41:30.407Z",
    "created_by": "text",
    "updated_at": "2026-03-18T06:41:30.407Z",
    "updated_by": "text"
  }
}

Delete Global Event Rule by ID

delete

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/global-event-rules/{ger_id}

Delete a GER by its ID

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete

/v3/global-event-rules/{ger_id}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.GlobalEventRules.DeleteRule(ctx, 491102)
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Update Global Event Rule by ID

patch

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/global-event-rules/{ger_id}

Update a GER by its ID

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

Body

application/json

namestringOptional

descriptionstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch

/v3/global-event-rules/{ger_id}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.GlobalEventRules.UpdateByID(ctx, 885894, components.V3GlobalEventRulesUpdateGlobalEventRuleRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "owner_id": "text",
    "name": "text",
    "description": "text",
    "routing_key": "text",
    "entity_owner": {
      "id": "text",
      "type": "team"
    },
    "rulesets": [
      {
        "id": 1,
        "global_event_rule_id": 1,
        "alert_source_shortname": "text",
        "alert_source_version": "text",
        "ordering": [
          1
        ],
        "catch_all_action": {
          "route_to": "text"
        },
        "created_at": "2026-03-18T06:41:30.407Z",
        "created_by": "text",
        "updated_at": "2026-03-18T06:41:30.407Z",
        "updated_by": "text"
      }
    ],
    "created_at": "2026-03-18T06:41:30.407Z",
    "created_by": "text",
    "updated_at": "2026-03-18T06:41:30.407Z",
    "updated_by": "text"
  }
}