Rotate the signing secret
Creates a new secret, shown only in this response. While the overlap lasts, each delivery carries two signatures, one per secret, so you can switch yours without missing any.
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
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
How many hours the previous secret keeps signing alongside the new one, from 0 to 72. With 0 it stops being valid immediately: use it if it leaked.
0 <= value <= 7224Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/rotate-secret" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}Delete a webhook endpoint DELETE
Pending deliveries are discarded.
Your business's plan and usage for the month GET
The plan and usage of your key's business, as each live business has its own: the month's authorized `live` documents, the band they fall in and what they cost so far. A `live` document that would take the usage amount over the spending cap is rejected with `402 plan_limit` before it is numbered. A `sandbox` business answers its month's `sandbox` documents, with no amounts.