FD1 Webhooks

Fieldpine provides webhooks for a number of events. When an event is fired, a message is sent to your endpoint containing some level of detail

You can also subscribe to a "firehose" which is delivered over websockets and used for high volume data extraction. Firehoses are able to register for some additional events that are not practical over webhooks due to potential volume. Firehoses do not buffer or retry as much as webhooks; they store a limited number of messages to handle network failure and callers are responsible for restart logic.

• Webhook Static registered URL Fieldpine sends to when events happen
• Firehose Receives objects over a websocket as events happen
• Doorbell A doorbell URL is one that can be pinged, but does not explicitly require authorisation or Api Keys. Typically an external server 'rings a dorrbell' to say 'I have something for you', without passing any information of a sensitive nature. Doorbells do not respond with any data, and in fact can simply return 404 errors if they wish.

  For example, Fieldpine servers may ring a retailers doorbell when new data arrives. Fieldpine can call the retailer, but does not require any centralised Api Keys. Typically the receiver of a doorbell will schedule a poll operation.

Registering a Webhook

Registering a Firehose

A firehose instructs the server to send all events or changes to you.

Send a packet as shown over your websocket

{
    "a": "fd1.firehose.open_firehose",
    "rq": ....
    "v": {
        "event": ....,
        "scope": ...
        "from": ...
        "until": ...
        "payload": ...
        "filter": ...
    }
}

Payload Generic Format

{
    "rp": ....      // Original "rq" that requested the webhook or firehose event
    "r": "",
    "v": {
        // Event specific data
    }
}

Event Names