Escalation Policies

Get Escalation Policy By team

get

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

/v3/escalation-policies

Returns all escalation policy details of the given ownerID (teamId) in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

owner_idstringRequired

here owner_id represents team_id, if team_id is not provided, it will return escalation policies of all teams.

page_numberintegerOptional

page_sizeintegerOptional

Header parameters

authorizationstringRequired

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/escalation-policies

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.EscalationPolicies.GetByTeam(ctx, "<id>", nil, nil)
    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": "text",
      "name": "text",
      "description": "text",
      "organization_id": "text",
      "repetition": 1,
      "repeat_after": 1,
      "rules": [
        {
          "escalationTime": 1,
          "via": [
            "text"
          ],
          "roundrobin_enabled": true,
          "roundrobin_next_index": 1,
          "entities": [
            {
              "id": "text",
              "pid": 1,
              "type": "user"
            }
          ],
          "escalate_within_roundrobin": true,
          "repetition": 1,
          "repeat_after": 1
        }
      ],
      "slug": "text",
      "enable_incident_reminders": true,
      "incident_reminder_rules": [
        {
          "via": [
            "text"
          ],
          "time_interval": 1,
          "till": 1
        }
      ],
      "enable_incident_retrigger": true,
      "retrigger_after": 1,
      "entity_owner": {
        "id": "text",
        "type": "text"
      },
      "owner": {
        "id": "text",
        "type": "team"
      },
      "access_control": [
        {
          "user_id": "text",
          "abilities": {}
        }
      ]
    }
  ],
  "meta": {
    "total_count": 1
  }
}

Create Escalation Policies

post

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

/v3/escalation-policies

Add escalation policy to the organization. Returns the escalation policy object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

owner_idstringRequired

The ID of the team that owns this escalation policy.

namestringRequired

The name of the escalation policy.

descriptionstringRequired

A description of the escalation policy.

repetitioninteger · int32Required

The number of times the entire policy should be repeated.

repeat_afterinteger · int32Required

The time in minutes after which the policy should be repeated.

enable_incident_remindersbooleanRequired

Enable or disable incident reminders.

enable_incident_retriggerbooleanRequired

Enable or disable automatic incident re-triggering.

retrigger_afterinteger · int32Required

The time in hours after which an incident should be re-triggered.

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/escalation-policies

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.EscalationPolicies.Create(ctx, components.V3EscalationPoliciesCreateEscalationPolicyRequest{
        OwnerID: "<id>",
        Name: "<value>",
        Description: "properly aw gerbil address co-producer guzzle delight difficult",
        Repetition: 549305,
        RepeatAfter: 226311,
        Rules: []components.V3EscalationPoliciesEscalationPolicyRule{
            components.V3EscalationPoliciesEscalationPolicyRule{
                EscalationTime: 646220,
                Via: []string{
                    "<value 1>",
                    "<value 2>",
                },
                RoundrobinEnabled: true,
                RoundrobinNextIndex: 685302,
                Entities: []components.V3EscalationPoliciesEscalationEntity{},
                EscalateWithinRoundrobin: true,
                Repetition: 149319,
                RepeatAfter: 619552,
            },
        },
        EnableIncidentReminders: false,
        IncidentReminderRules: []components.V3EscalationPoliciesIncidentReminderRule{},
        EnableIncidentRetrigger: false,
        RetriggerAfter: 660610,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "organization_id": "text",
    "repetition": 1,
    "repeat_after": 1,
    "rules": [
      {
        "escalationTime": 1,
        "via": [
          "text"
        ],
        "roundrobin_enabled": true,
        "roundrobin_next_index": 1,
        "entities": [
          {
            "id": "text",
            "pid": 1,
            "type": "user"
          }
        ],
        "escalate_within_roundrobin": true,
        "repetition": 1,
        "repeat_after": 1
      }
    ],
    "slug": "text",
    "enable_incident_reminders": true,
    "incident_reminder_rules": [
      {
        "via": [
          "text"
        ],
        "time_interval": 1,
        "till": 1
      }
    ],
    "enable_incident_retrigger": true,
    "retrigger_after": 1,
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ]
  }
}

Get Escalation Policy By ID

get

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

/v3/escalation-policies/{escalationPolicyID}

Returns an escalation policy details of the given escalationPolicyID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

escalationPolicyIDstringRequired

(Required) escalation policy ID

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/escalation-policies/{escalationPolicyID}

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.EscalationPolicies.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "organization_id": "text",
    "repetition": 1,
    "repeat_after": 1,
    "rules": [
      {
        "escalationTime": 1,
        "via": [
          "text"
        ],
        "roundrobin_enabled": true,
        "roundrobin_next_index": 1,
        "entities": [
          {
            "id": "text",
            "pid": 1,
            "type": "user"
          }
        ],
        "escalate_within_roundrobin": true,
        "repetition": 1,
        "repeat_after": 1
      }
    ],
    "slug": "text",
    "enable_incident_reminders": true,
    "incident_reminder_rules": [
      {
        "via": [
          "text"
        ],
        "time_interval": 1,
        "till": 1
      }
    ],
    "enable_incident_retrigger": true,
    "retrigger_after": 1,
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ]
  }
}

Update Escalation Policy

post

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

/v3/escalation-policies/{escalationPolicyID}

Update organization escalation policy details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

escalationPolicyIDstringRequired

(Required) escalation policy ID

Header parameters

authorizationstringRequired

Body

text/plain

owner_idstringOptional

The ID of the team that owns this escalation policy.

namestringOptional

The name of the escalation policy.

descriptionstringOptional

A description of the escalation policy.

repetitioninteger · int32Optional

The number of times the entire policy should be repeated.

repeat_afterinteger · int32Optional

The time in minutes after which the policy should be repeated.

enable_incident_remindersbooleanOptional

Enable or disable incident reminders.

enable_incident_retriggerbooleanOptional

Enable or disable automatic incident re-triggering.

retrigger_afterinteger · int32Optional

The time in hours after which an incident should be re-triggered.

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

post

/v3/escalation-policies/{escalationPolicyID}

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")),
    )

    example, fileErr := os.Open("example.file")
    if fileErr != nil {
        panic(fileErr)
    }

    res, err := s.EscalationPolicies.Update(ctx, "<id>", example)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "organization_id": "text",
    "repetition": 1,
    "repeat_after": 1,
    "rules": [
      {
        "escalationTime": 1,
        "via": [
          "text"
        ],
        "roundrobin_enabled": true,
        "roundrobin_next_index": 1,
        "entities": [
          {
            "id": "text",
            "pid": 1,
            "type": "user"
          }
        ],
        "escalate_within_roundrobin": true,
        "repetition": 1,
        "repeat_after": 1
      }
    ],
    "slug": "text",
    "enable_incident_reminders": true,
    "incident_reminder_rules": [
      {
        "via": [
          "text"
        ],
        "time_interval": 1,
        "till": 1
      }
    ],
    "enable_incident_retrigger": true,
    "retrigger_after": 1,
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ]
  }
}

Remove Escalation Policy

delete

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

/v3/escalation-policies/{escalationPolicyID}

Remove escalation policy from the organization. Upon success, the escalation policy will be removed from the organization. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

escalationPolicyIDstringRequired

(Required) escalation policy ID

Header parameters

authorizationstringRequired

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/escalation-policies/{escalationPolicyID}

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.EscalationPolicies.Remove(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}