starkbank.webhook

Liking cljdoc? Tell your friends :D

Clojure only.

create
created-java-webhook
delete
get
java-params
java-webhook-params
query

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", "deposit", "brcode-payment"]

Attributes:

: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", "deposit", "brcode-payment"]

## Attributes:
  - `:id` [string, default nil]: unique id returned when the webhook is created. ex: "5656565656565656"

raw docstring

create^clj

(create webhook-params)

(create webhook-params user)

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 or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

Webhook map with updated attributes

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 or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

## Return:
  - Webhook map with updated attributes

source raw docstring

created-java-webhook^clj

source

delete^clj

(delete id)

(delete id user)

Delete a Webhook subscription entity previously created in the Stark Bank API

Parameters (required):

id [string]: Webhook unique id. ex: "5656565656565656"

Options:

:user [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

deleted Webhook with updated attributes

Delete a Webhook subscription entity previously created in the Stark Bank API

## Parameters (required):
  - `id` [string]: Webhook unique id. ex: "5656565656565656"

## Options:
  - `:user` [Project or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

## Return:
  - deleted Webhook with updated attributes

source raw docstring

get^clj

(get id)

(get id user)

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 or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

Webhook map with updated attributes

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 or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

## Return:
  - Webhook map with updated attributes

source raw docstring

java-params^clj

source

java-webhook-params^clj

source

query^clj

(query)

(query params)

(query params user)

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 or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

Return:

stream of Webhook maps with updated attributes

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 or Organization]: Project or Organization map returned from starkbank.user/project or starkbank.user/organization. Only necessary if starkbank.settings/user has not been set.

## Return:
  - stream of Webhook maps with updated attributes

source raw docstring