Webhook

Example Callback

​

This is an example of an event notification callback endpoint that can receive event notifications. Implementing this endpoint is the responsibility of the API consumer.

These definitions are provided for reference when implementing your callback endpoint.

For an implementation guide, refer to the Events: Basic Usage Guide.

Body
required
application/json

Event notification payload

  • account_id
    Type: integer
    required

    ID of the account associated with the event

  • callback_id
    Type: integer
    required

    ID of the callback receiving the event

  • data
    required

    Event-specific data payload

    • member
      Type: object
      required
  • event_name
    Type: string
    required

    Name of the event

  • occurred_at
    Type: stringFormat: date-time
    required

    Timestamp when the event occurred

  • source_identifier
    Type: string
    required

    Primary identifier related to the event

  • subscription_id
    Type: integer
    required

    ID of the subscription associated with the event

  • trace_id
    Type: string
    required

    Internal trace ID, useful for debugging

  • uuid
    Type: stringFormat: uuid
    required

    Unique identifier for the event notification

Responses
  • 200

    Callback received successfully

  • 400

    Bad request

Request Example for post/example/callback_example
{
  "uuid": "",
  "account_id": 100,
  "occurred_at": "",
  "event_name": "sf.member.created",
  "callback_id": 345,
  "subscription_id": 1,
  "source_identifier": "",
  "trace_id": "",
  "data": {
    "member": {
      "id": 1,
      "identifier": "",
      "created_at": ""
    }
  }
}
No Body

Callback received successfully