[POST] /business/webhook

Atualizar a URL dos seus Webhooks

Endpoint de produçãoCopied!

Método POST

https://api.firebanking.com.br/business/webhook

RequisiçãoCopied!

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
apiKey	123	string	Sua chave API

Campos a serem enviados no Body

Parâmetros da rota

Campo	Obrigatório	Descrição
pixWebhookUrl	Não	URL para envio de todos os webhooks para o produto PIX. Essa URL deve conter o protocolo HTTPS, do contrário irá resultar em um erro de validação.
bankSlipWebhookUrl	Não	URL para envio de todos os webhooks para o produto Boleto. Essa URL deve conter o protocolo HTTPS, do contrário irá resultar em um erro de validação.
onboardingWebhookUrl	Não	URL para envio de todos os webhooks para o fluxo de Onboarding (abertura de contas via API). Essa URL deve conter o protocolo HTTPS, do contrário irá resultar em um erro de validação.

Campo

Obrigatório

Descrição

pixWebhookUrl

Não

URL para envio de todos os webhooks para o produto PIX.

Essa URL deve conter o protocolo HTTPS, do contrário irá resultar em um erro de validação.

bankSlipWebhookUrl

Não

URL para envio de todos os webhooks para o produto Boleto.

Essa URL deve conter o protocolo HTTPS, do contrário irá resultar em um erro de validação.

onboardingWebhookUrl

Não

URL para envio de todos os webhooks para o fluxo de Onboarding (abertura de contas via API).

Essa URL deve conter o protocolo HTTPS, do contrário irá resultar em um erro de validação.

cURL

curl --request POST \
  --url https://api.firebanking.com.br/business/integration \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: <sua-chave-api>' \
  --data '{
  "pixWebhookUrl": "https://webhook.site/123",
  "bankSlipWebhookUrl": "https://webhook.site/456",
  "onboardingWebhookUrl": "https://webhook.site/789"
}'

Exemplo de respostaCopied!

Campos a serem recebidos

JSON

{
	"status": 201,
	"message": "Webhook URLs updated successfully",
	"data": {
		"pixWebhookUrl": "https://webhook.site/123",
		"bankSlipWebhookUrl": "https://webhook.site/456",
		"onboardingWebhookUrl": "https://webhook.site/789"
	}
}

Exemplo de erroCopied!

Erro 400

JSON

{
	"statusCode": 400,
	"message": [
		"pixWebhookUrl needs to be a valid URL and use HTTPS protocol",
		"bankSlipWebhookUrl needs to be a valid URL and use HTTPS protocol",
		"onboardingWebhookUrl needs to be a valid URL and use HTTPS protocol"
	]
}

Onboarding WebhookCopied!

Esse webhook só é enviado caso a sua conta esteja habilitado o fluxo de Onboarding (abertura de contas via API). Para saber mais, fale com um de nossos especialistas.