Webhooks

Overview

Available Operations

• create - Create Webhook

• delete - Delete Webhook

• get_by_id - Get Webhook By ID

• update - Update Webhook

create

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.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.webhooks.create(name="<value>", triggers=[], urls=[
        {},
    ], trigger_type="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
name	str	✔️	Name of the webhook
triggers	List[models.V3ExtensionsWebhooksWebhookTrigger]	✔️	A list of triggers for this webhook
urls	List[models.V3ExtensionsWebhooksWebhookURL]	✔️	A list of URLs to which the webhook payload will be sent
trigger_type	str	✔️	Type of trigger
description	Optional[str]	➖	Description of the webhook
header	OptionalNullable[models.V3ExtensionsWebhooksWebhookHeader]	➖	Headers to be sent with the webhook
filters	OptionalNullable[models.V3ExtensionsWebhooksWebhookFilter]	➖	Filters to apply to the webhook
max_retry	Optional[int]	➖	Maximum number of retries for the webhook
teams	List[str]	➖	List of team IDs to which this webhook is applicable
is_all_teams_configured	Optional[bool]	➖	Set to true if the webhook is configured for all teams
custom_payload_template_slug	Optional[str]	➖	Slug of the custom payload template
language	Optional[str]	➖	Language for the webhook payload
mail_ids	List[str]	➖	List of email IDs for notification
custom_payload	Optional[str]	➖	Custom payload for the webhook
payload_type	Optional[str]	➖	Type of payload
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.WebhooksCreateWebhookResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

delete

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.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.webhooks.delete(event_webhook_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
event_webhook_id	str	✔️	(Required) event webhook ID
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_by_id

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.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.webhooks.get_by_id(event_webhook_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
event_webhook_id	str	✔️	(Required) event webhook ID
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.WebhooksGetWebhookByIDResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update

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

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.webhooks.update(event_webhook_id="<id>", name="<value>", triggers=[
        {
            "event_class": "<value>",
            "event_type": "<value>",
        },
    ], urls=[
        {},
    ], trigger_type="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
event_webhook_id	str	✔️	N/A
name	str	✔️	Name of the webhook
triggers	List[models.V3ExtensionsWebhooksWebhookTrigger]	✔️	A list of triggers for this webhook
urls	List[models.V3ExtensionsWebhooksWebhookURL]	✔️	A list of URLs to which the webhook payload will be sent
trigger_type	str	✔️	Type of trigger
description	Optional[str]	➖	Description of the webhook
header	OptionalNullable[models.V3ExtensionsWebhooksWebhookHeader]	➖	Headers to be sent with the webhook
filters	OptionalNullable[models.V3ExtensionsWebhooksWebhookFilter]	➖	Filters to apply to the webhook
max_retry	Optional[int]	➖	Maximum number of retries for the webhook
teams	List[str]	➖	List of team IDs to which this webhook is applicable
is_all_teams_configured	Optional[bool]	➖	Set to true if the webhook is configured for all teams
custom_payload_template_slug	Optional[str]	➖	Slug of the custom payload template
language	Optional[str]	➖	Language for the webhook payload
mail_ids	List[str]	➖	List of email IDs for notification
custom_payload	Optional[str]	➖	Custom payload for the webhook
payload_type	Optional[str]	➖	Type of payload
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.WebhooksUpdateWebhookResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*