Book Transfer Webhook

WEBHOOK book

Example

{
  "id": "<string>",
  "url": "<string>",
  "data": {
    "amount": "<string>",
    "bank_id": "<string>",
    "description": "<string>",
    "error": "<string>",
    "from_account_id": "<string>",
    "id": "<string>",
    "org_id": "<string>",
    "status": "<string>",
    "to_account_id": "<string>",
    "userdata": {}
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

event · enum<string> · required

Available options: book.create, book.update

id · string · required

ID of the object the event is about

op · enum<string> · required

Available options: create, update

url · string · required

URL to fetch the object

data · object

Snapshot of the object as of the event. Omitted when the organization does not receive full-object webhooks, or when the object cannot be rendered.

Show child attributes

Response

200

Return a 200 or 202 status code to acknowledge receipt.