API keys and webhooks
Build your own integrations with the REST API and signed webhooks.
Short on time? Ask Fieldnote about this article and get the answer with sources.
#API keys
The REST API is on the Business plan. Admins create keys in Settings > Developers > API keys. A key is shown once when it is created; store it somewhere safe. Each key can be read-only or read and write. The rate limit is 120 requests per minute per key; requests over the limit get HTTP status 429 and should be retried after the time in the Retry-After header.
#Webhooks
Add a webhook endpoint in Settings > Developers > Webhooks and pick the events to receive: job.created, job.completed, invoice.paid and payment.failed. Every request is signed with HMAC SHA-256 in the Fieldnote-Signature header, using the endpoint's signing secret, so you can check it really came from Fieldnote. If your endpoint does not answer with a 2xx status, Fieldnote retries up to 5 times over 24 hours, then marks the delivery as failed in the webhook log.
Was this article helpful?
Thanks for telling us. Still stuck?