Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt

Use this file to discover all available pages before exploring further.

The payload for a webhook is a single event referencing a resource that has recently changed. The data in target always represents a nested resource as returned by the regular API endpoints. 
{
  "type": "event",
  "name": "buyer.created",
  "id": "d99a867a-a326-447f-b61e-2825ebe6f0c5",
  "merchant_account_id": "default",
  "gr4vy_id": "example",
  "environment": "sandbox",
  "created_at": "2024-11-20T16:50:52.609674+00:00",
  "target": {
    "type": "buyer",
    "id": "f9d46f71-60d8-4b61-bddb-001a04c8224c",
    "display_name": "John Smith",
    "external_identifier": "user-123",
    "created_at": "2024-11-20T16:50:52.603191+00:00",
    "updated_at": "2024-11-20T16:50:52.603191+00:00",
    "billing_details": {
      "first_name": "John",
      "last_name": "Smith",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "Springfield",
        "country": "US",
        "postal_code": "123456",
        "state": "CA",
        "state_code": "US-CA",
        "house_number_or_name": "21",
        "line1": "22nd Street",
        "line2": "",
        "organization": "Acme Inc"
      },
      "tax_id": {
        "value": "12-3456789",
        "kind": "us.ein"
      }
    }
  }
}