Extensions/Webhooks

Get All Webhooks

get

https://api.squadcast.comhttps://api.eu.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

HTTPcURLJavaScriptPython

GET /v3/extensions/event-webhooks HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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.squadcast.comhttps://api.eu.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

headerobject · nullableOptional

Headers to be sent with the webhook

max_retryinteger · uint8Optional

Maximum number of retries for the webhook

teamsstring[] · nullableOptional

List of team IDs to which this webhook is applicable

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_idsstring[] · nullableOptional

List of email IDs for notification

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

HTTPcURLJavaScriptPython

POST /v3/extensions/event-webhooks HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "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"
}

{
  "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.squadcast.comhttps://api.eu.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}

HTTPcURLJavaScriptPython

GET /v3/extensions/event-webhooks/{eventWebhookID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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.squadcast.comhttps://api.eu.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

headerobject · nullableOptional

Headers to be sent with the webhook

max_retryinteger · uint8Optional

Maximum number of retries for the webhook

teamsstring[] · nullableOptional

List of team IDs to which this webhook is applicable

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_idsstring[] · nullableOptional

List of email IDs for notification

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}

HTTPcURLJavaScriptPython

PUT /v3/extensions/event-webhooks/{eventWebhookID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "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"
}

{
  "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.squadcast.comhttps://api.eu.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.

*/*

objectOptional

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}

HTTPcURLJavaScriptPython

DELETE /v3/extensions/event-webhooks/{eventWebhookID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}