Services/Overlay/Custom Content Templates

Get All Custom Content Template Overlay by Service

get

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

/v3/services/{serviceID}/overlays/custom-content

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Header parameters

authorizationstringOptional

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/services/{serviceID}/overlays/custom-content

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

{
  "data": [
    {
      "created_at": "2026-03-18T06:41:45.070Z",
      "updated_at": "2026-03-18T06:41:45.070Z",
      "deleted_at": "2026-03-18T06:41:45.070Z",
      "org_id": "text",
      "service_id": "text",
      "alert_source_version": "text",
      "alert_source_shortname": "text",
      "overlay_template_type": "message",
      "overlay": {
        "message": "text",
        "description": "text"
      },
      "created_by": "text",
      "updated_by": "text",
      "alert_source_type": "text"
    }
  ]
}

Render Custom Content Overlay

post

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

/v3/services/{serviceID}/overlays/custom-content/render

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

application/json

overlay_template_typestringRequired

templatestringRequired

payloadstringRequired

Responses

200

The request has succeeded.

application/json

datastringRequired

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/services/{serviceID}/overlays/custom-content/render

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.Services.Overlays.CustomContent.Render(ctx, "<id>", components.V3ServicesOverlayRenderCustomContentOverlayRequest{
        OverlayTemplateType: "<value>",
        Template: "<value>",
        Payload: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": "text"
}

Get Custom Content Template Overlay

get

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

/v3/services/{serviceID}/overlays/custom-content/{alertSource}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

alertSourcestringRequired

Header parameters

authorizationstringOptional

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/services/{serviceID}/overlays/custom-content/{alertSource}

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

{
  "data": {
    "created_at": "2026-03-18T06:41:45.070Z",
    "updated_at": "2026-03-18T06:41:45.070Z",
    "deleted_at": "2026-03-18T06:41:45.070Z",
    "org_id": "text",
    "service_id": "text",
    "alert_source_version": "text",
    "alert_source_shortname": "text",
    "overlay_template_type": "message",
    "overlay": {
      "message": "text",
      "description": "text"
    },
    "created_by": "text",
    "updated_by": "text",
    "alert_source_type": "text"
  }
}

Create or Update Notification Template Overlay

put

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

/v3/services/{serviceID}/overlays/custom-content/{alertSource}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

alertSourcestringRequired

Body

application/json

overlay_template_typestringRequired

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

put

/v3/services/{serviceID}/overlays/custom-content/{alertSource}

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.Services.CreateOrUpdateNotificationTemplateOverlay(ctx, "<id>", "<value>", components.V3ServicesOverlayUpdateCustomContentTemplateOverlayRequest{
        OverlayTemplateType: "<value>",
        MessageOverlay: components.MessageOverlay{
            Template: "<value>",
        },
        DescriptionOverlay: components.DescriptionOverlay{
            Template: "<value>",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "created_at": "2026-03-18T06:41:45.070Z",
    "updated_at": "2026-03-18T06:41:45.070Z",
    "deleted_at": "2026-03-18T06:41:45.070Z",
    "org_id": "text",
    "service_id": "text",
    "alert_source_version": "text",
    "alert_source_shortname": "text",
    "overlay_template_type": "message",
    "overlay": {
      "message": "text",
      "description": "text"
    },
    "created_by": "text",
    "updated_by": "text",
    "alert_source_type": "text"
  }
}

Delete Notification Template Overlay

delete

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

/v3/services/{serviceID}/overlays/custom-content/{alertSource}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

alertSourcestringRequired

Header parameters

authorizationstringOptional

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/services/{serviceID}/overlays/custom-content/{alertSource}

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

{}