Toggle Developers
HomeAcademy
  • Welcome
  • GraphQL
    • Getting started
    • Exploring our API
    • Authentication
    • API playground
    • Error handling
  • Key concepts
    • Overview
      • Orders, Transactions & Line Items
      • Card number formats
  • Basics
    • Create a card
    • Check a card balance
    • Redeem a card
  • Webhooks
    • Overview
      • Getting started
      • Authentication & responses
    • Events
      • Card.balance_adjusted
      • Card.card_reference_updated
      • Card.expiry_reminder
      • Card.registered
      • Card.send_recipient_email
      • Card.resend_recipient_email
      • Order.created
      • Order.cancelled
      • Order.send_receipt_email
      • Order.send_cancellation_email
      • Payment.failed
      • Payment.review_opened
      • Fulfilment.dispatched
  • Partner Guides
    • EPOS & Ordering
      • Overview
      • Accreditation
      • Configuration variables
      • Playground examples
      • Physical card orders
      • Custom validity rules
      • Balance check
      • Redemptions & top-ups
      • Reversals
    • Guest gratuity
      • Overview
      • Accreditation
      • Configuration variables
      • Playground examples
      • Creating a card
      • Cancelling a card
      • Register a card
    • CRM
      • Overview
      • Historic data via GraphQL
      • Real time data via webhooks
Powered by GitBook
On this page
  1. Webhooks
  2. Events

Card.send_recipient_email

This event is dispatched whenever a card recipient email is sent.

Example payload

{
  "id": 568,
  "object": "event",
  "api_version": "3.2",
  "webhook_version": "1.0",
  "created_at": "2021-04-11T16:01:27.000000Z",
  "type": "card.send_recipient_email",
  "data": {
    "object": {
      "object": "card",
      "id": 355,
      "balance": 1000,
      "card_reference": "6301190045888067809",
      "pin": 134702,
      "expiry_time": "2021-03-27T23:59:59.000000Z",
      "validity_start_time": "2021-03-12T00:00:00.000000Z",
      "personal_message": null,
      "qr_code_url": "https://apimytoggleio-dev.airship.co.uk/qrcodegenerator/6301190045888067809",
      "account_id": 1,
      "purchaser_contact": {
        "object": "contact",
        "id": 703,
        "email": "john@example.co.uk",
        "first_name": "John",
        "last_name": "Smith",
        "phone_number": null,
        "marketing_opt_in_at": null
      },
      "product": {
        "object": "product",
        "id": 4,
        "name": "Gift Card",
        "short_description": "Gift Card",
        "long_description": "Gift Card",
        "image": {
          "object": "image",
          "id": 13,
          "url": "https://apimytoggleio-dev.airship.co.uk//storage/images/1_1616686008.png"
        },
        "product_type": {
          "object": "product_type",
          "id": 1,
          "name": "Gift Card"
        }
      },
      "contact": null,
      "currency": {
        "object": "currency",
        "id": 1,
        "name": "Sterling",
        "denomination": 100,
        "iso_currency_code": "GBP"
      },
      "line_item_fulfilment": {
        "object": "line_item_fulfilment",
        "id": 350,
        "tracking_reference": null,
        "postage_type": null,
        "address": null,
        "contact": {
          "object": "contact",
          "id": 704,
          "email": "john@example.co.uk",
          "first_name": null,
          "last_name": null,
          "phone_number": null,
          "marketing_opt_in_at": null
        },
        "fulfilment_method": {
          "object": "fulfilment_method",
          "id": 1,
          "name": "Email"
        }
      },
      "card_alias": {
        "object": "card_alias",
        "card_alias": "18347923487",
        "card_alias_pin": "1234",
      }
    }
  }
}
PreviousCard.registeredNextCard.resend_recipient_email

Last updated 3 years ago