Extensions/Webhooks

Get All Webhooks

get

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

/v3/extensions/event-webhooks

Returns all the webhooks of the organization. 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

page-limitstringOptional

offsetstringOptional

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/extensions/event-webhooks

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.Webhooks.GetAll(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ExtensionsWebhooksGetAllWebhooksResponse != nil {
        // handle response
    }
}

{
  "data": {
    "result": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "trigger_type": "text",
        "payload_type": "text",
        "custom_payload_template_name": "text"
      }
    ],
    "meta": {
      "total_count": 1
    }
  }
}

Create Webhook

post

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

/v3/extensions/event-webhooks

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

namestringRequired

Name of the webhook

descriptionstringOptional

Description of the webhook

headerany ofOptional

Headers to be sent with the webhook

objectOptional

or

nullOptional

filtersany ofOptional

Filters to apply to the webhook

or

nullOptional

max_retryinteger · uint8Optional

Maximum number of retries for the webhook

teamsany ofOptional

List of team IDs to which this webhook is applicable

string[]Optional

or

nullOptional

is_all_teams_configuredbooleanOptional

Set to true if the webhook is configured for all teams

custom_payload_template_slugstringOptional

Slug of the custom payload template

languagestringOptional

Language for the webhook payload

mail_idsany ofOptional

List of email IDs for notification

string[]Optional

or

nullOptional

trigger_typestringRequired

Type of trigger

custom_payloadstringOptional

Custom payload for the webhook

payload_typestringOptional

Type of payload

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/extensions/event-webhooks

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.Webhooks.Create(ctx, components.V3ExtensionsWebhooksWebhook{
        Name: "<value>",
        Triggers: []components.V3ExtensionsWebhooksWebhookTrigger{},
        Urls: []components.V3ExtensionsWebhooksWebhookURL{
            components.V3ExtensionsWebhooksWebhookURL{},
        },
        TriggerType: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "body": {
    "data": {
      "id": "text",
      "created_at": "text",
      "updated_at": "text",
      "organization_id": "text",
      "author_id": "text",
      "slug": "text",
      "version": "text",
      "name": "text",
      "description": "text",
      "triggers": [
        {
          "event_class": "text",
          "event_type": "text"
        }
      ],
      "urls": [
        {
          "url": "text",
          "method": "text"
        }
      ],
      "header": {},
      "filters": {
        "op": "text",
        "conditions": [
          {
            "op": "text",
            "lhs": "text",
            "rhs": "text"
          }
        ]
      },
      "max_retry": 1,
      "teams": [
        "text"
      ],
      "is_all_teams_configured": true,
      "custom_payload_template_slug": "text",
      "language": "text",
      "mail_ids": [
        "text"
      ],
      "trigger_type": "text",
      "custom_payload": "text",
      "payload_type": "text"
    }
  }
}

Get Webhook By ID

get

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

/v3/extensions/event-webhooks/{eventWebhookID}

Returns a webhooks details of the given eventWebhookID 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

eventWebhookIDstringRequired

(Required) event webhook 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/extensions/event-webhooks/{eventWebhookID}

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

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "organization_id": "text",
    "author_id": "text",
    "slug": "text",
    "version": "text",
    "name": "text",
    "description": "text",
    "triggers": [
      {
        "event_class": "text",
        "event_type": "text"
      }
    ],
    "urls": [
      {
        "url": "text",
        "method": "text"
      }
    ],
    "header": {},
    "filters": {
      "op": "text",
      "conditions": [
        {
          "op": "text",
          "lhs": "text",
          "rhs": "text"
        }
      ]
    },
    "max_retry": 1,
    "teams": [
      "text"
    ],
    "is_all_teams_configured": true,
    "custom_payload_template_slug": "text",
    "language": "text",
    "mail_ids": [
      "text"
    ],
    "trigger_type": "text",
    "custom_payload": "text",
    "payload_type": "text"
  }
}

Update Webhook

put

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

/v3/extensions/event-webhooks/{eventWebhookID}

Update organization webhook 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

eventWebhookIDstringRequired

Body

application/json

namestringRequired

Name of the webhook

descriptionstringOptional

Description of the webhook

headerany ofOptional

Headers to be sent with the webhook

objectOptional

or

nullOptional

filtersany ofOptional

Filters to apply to the webhook

or

nullOptional

max_retryinteger · uint8Optional

Maximum number of retries for the webhook

teamsany ofOptional

List of team IDs to which this webhook is applicable

string[]Optional

or

nullOptional

is_all_teams_configuredbooleanOptional

Set to true if the webhook is configured for all teams

custom_payload_template_slugstringOptional

Slug of the custom payload template

languagestringOptional

Language for the webhook payload

mail_idsany ofOptional

List of email IDs for notification

string[]Optional

or

nullOptional

trigger_typestringRequired

Type of trigger

custom_payloadstringOptional

Custom payload for the webhook

payload_typestringOptional

Type of payload

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/extensions/event-webhooks/{eventWebhookID}

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.Webhooks.Update(ctx, "<id>", components.V3ExtensionsWebhooksWebhook{
        Name: "<value>",
        Triggers: []components.V3ExtensionsWebhooksWebhookTrigger{
            components.V3ExtensionsWebhooksWebhookTrigger{
                EventClass: "<value>",
                EventType: "<value>",
            },
        },
        Urls: []components.V3ExtensionsWebhooksWebhookURL{
            components.V3ExtensionsWebhooksWebhookURL{},
        },
        TriggerType: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "organization_id": "text",
    "author_id": "text",
    "slug": "text",
    "version": "text",
    "name": "text",
    "description": "text",
    "triggers": [
      {
        "event_class": "text",
        "event_type": "text"
      }
    ],
    "urls": [
      {
        "url": "text",
        "method": "text"
      }
    ],
    "header": {},
    "filters": {
      "op": "text",
      "conditions": [
        {
          "op": "text",
          "lhs": "text",
          "rhs": "text"
        }
      ]
    },
    "max_retry": 1,
    "teams": [
      "text"
    ],
    "is_all_teams_configured": true,
    "custom_payload_template_slug": "text",
    "language": "text",
    "mail_ids": [
      "text"
    ],
    "trigger_type": "text",
    "custom_payload": "text",
    "payload_type": "text"
  }
}

Delete Webhook

delete

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

/v3/extensions/event-webhooks/{eventWebhookID}

Remove webhook from the organization. Upon success, the webhook 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

eventWebhookIDstringRequired

(Required) event webhook ID

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/extensions/event-webhooks/{eventWebhookID}

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

{}