pinxs v2.0.3 PINXS.Webhooks.Webhook View Source
The webhook module allows you to create and view your webhook endpoints.
Required fields
When creating a webhook only URL is required
create(%Webhook{url: "https://awesome.com"}, PINXS.config("my key"))
Link to this section Summary
Functions
Creates a webhook
Link to this section Types
Link to this type
t()
View Source
t() :: %PINXS.Webhooks.Webhook{ created_at: nil | DateTime.t(), key: nil | String.t(), token: nil | String.t(), updated_at: nil | DateTime.t(), url: String.t() }
Link to this section Functions
Link to this function
create(webhook, config)
View Source
create(PINXS.Webhooks.Webhook.t(), PINXS.t()) :: {:ok, PINXS.Webhooks.Webhook.t()} | {:error, PINXS.Error.t()}
Creates a webhook
Link to this function
delete(token, config)
View Source
delete(String.t(), PINXS.t()) :: {:ok, true} | {:error, PINXS.Error.t()}
Link to this function
get(config)
View Source
get(PINXS.t()) :: {:ok, Webook.t() | {:error, PINXS.Error.t()}}
Link to this function
get(token, config)
View Source
get(String.t(), %PINXS{api_key: term(), url: term()}) :: {:ok, PINXS.Webhooks.Webhook.t()} | {:error, PINXS.Error.t()}