airflow.providers.zendesk.hooks.zendesk

Module Contents

Classes

ZendeskHook

Interact with Zendesk. This hook uses the Zendesk conn_id.
class airflow.providers.zendesk.hooks.zendesk.ZendeskHook(zendesk_conn_id: str)[source]

Bases: airflow.hooks.base.BaseHook

Interact with Zendesk. This hook uses the Zendesk conn_id.

Parameters

zendesk_conn_id (str) -- The Airflow connection used for Zendesk credentials.

get_conn(self) → zdesk.Zendesk[source]

Returns connection for the hook.

call(self, path: str, query: Optional[dict] = None, get_all_pages: bool = True, side_loading: bool = False) → dict[source]

Call Zendesk API and return results

Parameters

  • path -- The Zendesk API to call

  • query -- Query parameters

  • get_all_pages -- Accumulate results over all pages before returning. Due to strict rate limiting, this can often timeout. Waits for recommended period between tries after a timeout.

  • side_loading -- Retrieve related records as part of a single request. In order to enable side-loading, add an 'include' query parameter containing a comma-separated list of resources to load. For more information on side-loading see https://developer.zendesk.com/rest_api/docs/core/side_loading

Was this entry helpful?