A Webhook is used to subscribe to notification events on a user-selected endpoint. Currently available services for subscription are transfer, boleto, boleto-payment, and utility-payment
:url [string]: Url that will be notified when an event occurs.:subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "boleto-payment"]:id [string, default nil]: unique id returned when the webhook is created. ex: "5656565656565656"A Webhook is used to subscribe to notification events on a user-selected endpoint. Currently available services for subscription are transfer, boleto, boleto-payment, and utility-payment ## Parameters (required): - `:url` [string]: Url that will be notified when an event occurs. - `:subscriptions` [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "boleto-payment"] ## Attributes: - `:id` [string, default nil]: unique id returned when the webhook is created. ex: "5656565656565656"
(create webhook-params)(create webhook-params user)Send a single Webhook subscription for creation in the Stark Bank API
:url [string]: url to which notification events will be sent to. ex: "https://webhook.site/60e9c18e-4b5c-4369-bda1-ab5fcd8e1b29":subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "boleto-payment"]:user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.Send a single Webhook subscription for creation in the Stark Bank API ## Parameters (required): - `:url` [string]: url to which notification events will be sent to. ex: "https://webhook.site/60e9c18e-4b5c-4369-bda1-ab5fcd8e1b29" - `:subscriptions` [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "boleto-payment"] ## Parameters (optional): - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - Webhook map with updated attributes
(delete id)(delete id user)Delete a Webhook subscription entity previously created in the Stark Bank API
id [string]: Webhook unique id. ex: "5656565656565656":user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.Delete a Webhook subscription entity previously created in the Stark Bank API ## Parameters (required): - `id` [string]: Webhook unique id. ex: "5656565656565656" ## Options: - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - deleted Webhook with updated attributes
(get id)(get id user)Receive a single Webhook subscription map previously created in the Stark Bank API by passing its id
id [string]: map unique id. ex: "5656565656565656":user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.Receive a single Webhook subscription map previously created in the Stark Bank API by passing its id ## Parameters (required): - `id` [string]: map unique id. ex: "5656565656565656" ## Options: - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - Webhook map with updated attributes
(query)(query params)(query params user)Receive a stream of Webhook subcription maps previously created in the Stark Bank API
:limit [integer, default nil]: maximum number of maps to be retrieved. Unlimited if nil. ex: 35:user [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set.Receive a stream of Webhook subcription maps previously created in the Stark Bank API ## Options: - `:limit` [integer, default nil]: maximum number of maps to be retrieved. Unlimited if nil. ex: 35 - `:user` [Project]: Project map returned from starkbank.user/project. Only necessary if starkbank.user/set has not been set. ## Return: - stream of Webhook maps with updated attributes
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |