Webhook

RecipientUpdated Webhook

​

Webhook endpoint for receiving customer/recipient update events.

This endpoint receives webhooks when a customer verifies their email or changes their recurring payment method.

If you would like to start receiving this type of callback, please contact Billogram support.

Body·
required
application/json
  • callback_id
    Type: string
    required

    Unique identifier generated for each callback.

  • callback_timestamp
    Type: stringFormat: date-time
    required

    An ISO 8601 compliant timestamp for the callback.

  • callback_type
    const:  
    RecipientUpdated
    required

    The type of callback. Value is "RecipientUpdated" for customer callback events.

  • customer
    Type: object ·
    required
Responses
  • application/json
Request Example for postRecipientUpdated
{
  "customer": {
    "customer_number": 12345,
    "updated_email": "john.doe@example.com"
  },
  "callback_id": "9ec1c43a-0272-46f0-b4c2-9fe53acdb861",
  "callback_timestamp": "2015-12-04T13:28:51.706784Z",
  "callback_type": "RecipientUpdated"
}

{
  "status": "OK"
}

Webhook received successfully.

Required: Your endpoint must return HTTP 200 OK for the webhook to be considered successfully delivered. Any other status code will cause the webhook to be marked as failed and retried.