Webhooks

Create a webhook endpoint

POST
/v1/webhook-endpoints

Receives the events of your key's business in its environment by POST, and no other business's, signed according to Standard Webhooks, with retries spaced over about three days.

Authorization

AuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

HTTPS, at a public address, in every environment: deliveries leave from Fiscalbase, so localhost or a private network would never reach your machine. To receive them while you develop, use a tunnel with a public URL.

Formaturi
events?array<>
Items1 <= items

Default

[  "*"]

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/webhook-endpoints" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "webhook_endpoint",  "environment": "sandbox",  "url": "http://example.com",  "events": [    "*"  ],  "disabled": true,  "secret_hint": "string",  "previous_secret_expires_at": "2019-08-24T14:15:22Z",  "deliveries_24h": 0,  "failed_24h": 0,  "failing_since": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "secret": "string"}