Thinkific.Api.Webhooks (Thinkific API SDK v0.1.3)

API calls for all endpoints tagged Webhooks.

Link to this section Summary

Functions

create_webhook(connection, opts \\ [])

Create Webhook This endpoint creates a new Webhook

delete_webhook_by_id(connection, id, opts \\ [])

deleteWebhookByID This endpoint deletes the Webhook identified by the provided id.

get_webhook_by_id(connection, id, opts \\ [])

getWebhookByID This endpoint returns the Webhook identified by the provided id.

get_webhooks(connection, opts \\ [])

Get Webhooks This endpoint returns a list of Webhooks.

update_webhook_by_id(connection, id, body, opts \\ [])

updateWebhookByID This endpoint updates the Webhook identified by the provided id.

Link to this section Functions

create_webhook(connection, opts \\ [])

Specs

create_webhook(Tesla.Env.client(), keyword()) ::
  {:ok, Thinkific.Model.WebhookResponse.t()} | {:error, Tesla.Env.t()}

Create Webhook This endpoint creates a new Webhook

Parameters

connection (Thinkific.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :body (WebhookRequest): Webhook request type

Returns

} on success {:error, info} on failure

delete_webhook_by_id(connection, id, opts \\ [])

Specs

delete_webhook_by_id(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

deleteWebhookByID This endpoint deletes the Webhook identified by the provided id.

Parameters

connection (Thinkific.Connection): Connection to server
id (String.t): ID of the Webhook in the form of an string.
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

get_webhook_by_id(connection, id, opts \\ [])

Specs

get_webhook_by_id(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Thinkific.Model.WebhookResponse.t()} | {:error, Tesla.Env.t()}

getWebhookByID This endpoint returns the Webhook identified by the provided id.

Parameters

connection (Thinkific.Connection): Connection to server
id (String.t): ID of the Webhook in the form of an string.
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

get_webhooks(connection, opts \\ [])

Specs

get_webhooks(Tesla.Env.client(), keyword()) ::
  {:ok, Thinkific.Model.GetWebhooksResponse.t()} | {:error, Tesla.Env.t()}

Get Webhooks This endpoint returns a list of Webhooks.

Parameters

connection (Thinkific.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :page (float()): The page within the collection to fetch
- :limit (float()): The number of items to be returned

Returns

} on success {:error, info} on failure

update_webhook_by_id(connection, id, body, opts \\ [])

Specs

update_webhook_by_id(
  Tesla.Env.client(),
  String.t(),
  Thinkific.Model.WebhookRequest.t(),
  keyword()
) :: {:ok, Thinkific.Model.WebhookResponse.t()} | {:error, Tesla.Env.t()}

updateWebhookByID This endpoint updates the Webhook identified by the provided id.

Parameters

connection (Thinkific.Connection): Connection to server
id (String.t): ID of the Webhook in the form of an string.
body (WebhookRequest): Webhook request attributes
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure