Webforms

Get All Webforms

get

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

/v3/webform

Returns all webforms of the given owner_id (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

page_numberintegerOptional

page_sizeintegerOptional

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/webform

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.Webforms.GetAll(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": 1,
      "org_id": "text",
      "owner_id": "text",
      "name": "text",
      "is_cname": true,
      "public_url": "text",
      "host_name": "text",
      "tags": {},
      "is_captcha_enabled": true,
      "captcha_provider": "text",
      "captcha_secret": {
        "site_key": "text",
        "secret": "text"
      },
      "form_owner_type": "text",
      "form_owner_id": "text",
      "form_owner_name": "text",
      "services": [
        {
          "service_id": "text",
          "name": "text",
          "alias": "text"
        }
      ],
      "input_field": [
        {
          "label": "text",
          "options": [
            "text"
          ]
        }
      ],
      "header": "text",
      "title": "text",
      "logo_url": "text",
      "footer_text": "text",
      "footer_link": "text",
      "email_on": [
        "text"
      ],
      "description": "text",
      "incident_count": 1,
      "mttr": 1,
      "is_deleted": true,
      "deleted_at": "text"
    }
  ],
  "meta": {
    "total_count": 1
  }
}

Create Webform

post

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

/v3/webform

Add a webform to the organization. Returns the webform 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

Public API request for creating a webform

owner_idstringRequired

Unique identifier of the owner (string or UUID)

namestringRequired

Name of the webform

is_cnamebooleanRequired

Indicates if a custom domain (CNAME) is used

host_namestringOptional

Custom hostname if CNAME is enabled

tagsobjectOptional

Key-value tags for the webform

is_captcha_enabledbooleanRequired

Whether CAPTCHA is enabled on the form

form_owner_typestringRequired

Entity type that owns the form (e.g., team, user)

form_owner_idstringRequired

Identifier for the owner entity

headerstringRequired

Header text shown on the form

titlestringRequired

Title of the webform

logo_urlstringOptional

URL to the organization's logo

footer_textstringRequired

Text displayed in the footer

footer_linkstringRequired

Hyperlink in the footer (mailto or https)

email_onstring[]Optional

Emails to notify on submission

descriptionstringOptional

Optional description for the webform

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/webform

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.Webforms.Create(ctx, components.V3WebformsCreateOrUpdateWebformRequest{
        OwnerID: "<id>",
        Name: "<value>",
        IsCname: false,
        IsCaptchaEnabled: false,
        CaptchaSecret: components.V3WebformsRecaptchaSecrets{
            SiteKey: "<value>",
            Secret: "<value>",
        },
        FormOwnerType: "<value>",
        FormOwnerID: "<id>",
        Services: []components.V3WebformsWFService{},
        Header: "<value>",
        Title: "<value>",
        FooterText: "<value>",
        FooterLink: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "webform": {
      "id": 1,
      "org_id": "text",
      "owner_id": "text",
      "name": "text",
      "is_cname": true,
      "public_url": "text",
      "host_name": "text",
      "tags": {},
      "is_captcha_enabled": true,
      "captcha_provider": "text",
      "captcha_secret": {
        "site_key": "text",
        "secret": "text"
      },
      "form_owner_type": "text",
      "form_owner_id": "text",
      "form_owner_name": "text",
      "services": [
        {
          "service_id": "text",
          "name": "text",
          "alias": "text"
        }
      ],
      "input_field": [
        {
          "label": "text",
          "options": [
            "text"
          ]
        }
      ],
      "header": "text",
      "title": "text",
      "logo_url": "text",
      "footer_text": "text",
      "footer_link": "text",
      "email_on": [
        "text"
      ],
      "description": "text",
      "incident_count": 1,
      "mttr": 1,
      "is_deleted": true,
      "deleted_at": "text"
    }
  }
}

Get Webform By ID

get

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

/v3/webform/{webformId}

Returns a webform details of the given webformId 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

webformIdintegerRequired

Query parameters

owner_idstringRequired

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/webform/{webformId}

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

{
  "data": {
    "id": 1,
    "org_id": "text",
    "owner_id": "text",
    "name": "text",
    "is_cname": true,
    "public_url": "text",
    "host_name": "text",
    "tags": {},
    "is_captcha_enabled": true,
    "captcha_provider": "text",
    "captcha_secret": {
      "site_key": "text",
      "secret": "text"
    },
    "form_owner_type": "text",
    "form_owner_id": "text",
    "form_owner_name": "text",
    "services": [
      {
        "service_id": "text",
        "name": "text",
        "alias": "text"
      }
    ],
    "input_field": [
      {
        "label": "text",
        "options": [
          "text"
        ]
      }
    ],
    "header": "text",
    "title": "text",
    "logo_url": "text",
    "footer_text": "text",
    "footer_link": "text",
    "email_on": [
      "text"
    ],
    "description": "text",
    "incident_count": 1,
    "mttr": 1,
    "is_deleted": true,
    "deleted_at": "text"
  }
}

Update Webform

put

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

/v3/webform/{webformId}

Update a webform to the organization. Returns the webform 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>.

Path parameters

webformIdintegerRequired

Body

application/json

Public API request for creating a webform

owner_idstringRequired

Unique identifier of the owner (string or UUID)

namestringRequired

Name of the webform

is_cnamebooleanRequired

Indicates if a custom domain (CNAME) is used

host_namestringOptional

Custom hostname if CNAME is enabled

tagsobjectOptional

Key-value tags for the webform

is_captcha_enabledbooleanRequired

Whether CAPTCHA is enabled on the form

form_owner_typestringRequired

Entity type that owns the form (e.g., team, user)

form_owner_idstringRequired

Identifier for the owner entity

headerstringRequired

Header text shown on the form

titlestringRequired

Title of the webform

logo_urlstringOptional

URL to the organization's logo

footer_textstringRequired

Text displayed in the footer

footer_linkstringRequired

Hyperlink in the footer (mailto or https)

email_onstring[]Optional

Emails to notify on submission

descriptionstringOptional

Optional description for the webform

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/webform/{webformId}

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.Webforms.Update(ctx, 926692, components.V3WebformsCreateOrUpdateWebformRequest{
        OwnerID: "<id>",
        Name: "<value>",
        IsCname: true,
        IsCaptchaEnabled: true,
        CaptchaSecret: components.V3WebformsRecaptchaSecrets{
            SiteKey: "<value>",
            Secret: "<value>",
        },
        FormOwnerType: "<value>",
        FormOwnerID: "<id>",
        Services: []components.V3WebformsWFService{
            components.V3WebformsWFService{
                ServiceID: "<id>",
                Name: "<value>",
                Alias: "<value>",
            },
        },
        Header: "<value>",
        Title: "<value>",
        FooterText: "<value>",
        FooterLink: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "org_id": "text",
    "owner_id": "text",
    "name": "text",
    "is_cname": true,
    "public_url": "text",
    "host_name": "text",
    "tags": {},
    "is_captcha_enabled": true,
    "captcha_provider": "text",
    "captcha_secret": {
      "site_key": "text",
      "secret": "text"
    },
    "form_owner_type": "text",
    "form_owner_id": "text",
    "form_owner_name": "text",
    "services": [
      {
        "service_id": "text",
        "name": "text",
        "alias": "text"
      }
    ],
    "input_field": [
      {
        "label": "text",
        "options": [
          "text"
        ]
      }
    ],
    "header": "text",
    "title": "text",
    "logo_url": "text",
    "footer_text": "text",
    "footer_link": "text",
    "email_on": [
      "text"
    ],
    "description": "text",
    "incident_count": 1,
    "mttr": 1,
    "is_deleted": true,
    "deleted_at": "text"
  }
}

Remove Webform

delete

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

/v3/webform/{webformId}

Remove a webform 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

webformIdintegerRequired

Query parameters

owner_idstringRequired

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

delete

/v3/webform/{webformId}

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

{
  "data": "text"
}