`pyfivetran.endpoints.webhook`

Module Contents

Classes

WebhookEndpoint

API

class pyfivetran.endpoints.webhook.WebhookEndpoint(client: pyfivetran.endpoints.base.Client)[source]

Bases: pyfivetran.endpoints.base.Endpoint

BASE_URL: str = None

create_webhook(url: str, events: Optional[List[str]] = None, active: Optional[bool] = None, secret: Optional[str] = None, webhook_type: Literal[account, group] = 'account') → pyfivetran.shed.GeneralApiResponse[source]

Create a webhook for either a account or a group.

Parameters:

url – The url of the webhook
events – The events to subscribe to
active – Whether the webhook is active
secret – The secret of the webhook
webhook_type – The type of webhook

Returns:

GeneralApiResponse

delete_webhook(webhook_id: str) → pyfivetran.shed.GeneralApiResponse[source]

Delete a webhook.

Parameters:: webhook_id – The id of the webhook
Returns:: GeneralApiResponse

list_webhook(limit: Optional[int] = None) → Sequence[pyfivetran.shed.PaginatedApiResponse][source]

List all webhooks.

Parameters:: limit – The number of records to return
Returns:: Sequence[PaginatedApiResponse]

get_webhook(webhook_id: str) → pyfivetran.shed.GeneralApiResponse[source]

Get a webhook.

Parameters:: webhook_id – The id of the webhook
Returns:: GeneralApiResponse

test_webhook(webhook_id: str, event: str) → pyfivetran.shed.GeneralApiResponse[source]

Test a webhook.