One delivery, with the event as it was sent

GET https://api.app2email.com/v1/{number}/webhooks/{id}/deliveries/{event_id}
scope: webhooks:manage sandbox: reads

Every try, and next_attempt_at while a retry is planned. event_body only with a key that also has messages:read.

Path

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270
  • id string required

    The webhook's id.

    e.g. wh_a1b2c3d4e5f6g7h8
  • event_id string required

    The event's id (X-App2email-Delivery, or 'id' in the event).

    e.g. evt_Xq3k9m2

Responses

200 The delivery.
Fields
  • success boolean
  • request_id string
  • delivery object

    One event sent (or tried) to a webhook. Kept 7 days, the latest 100 per webhook.

    7 fields
    • event_id string
      e.g. evt_Xq3...
    • type string
      e.g. message.status
    • created string (date-time)
    • delivered boolean

      true: your URL answered 2xx.

    • attempts object[]

      Every try, in order.

      5 item fields
    • event_body object

      Only in GET .../deliveries/{event_id}: the event exactly as sent.

      6 fields
      • id string
        e.g. evt_Xq3...
      • type string 80 values
        message.statusmessage.receivedmessage.failedcontact.opted_outbroadcast.completedusage.thresholdtemplate.status_changedconversation.owner_changedmessage.held_for_approvalapproval.resolvedcontact.updatedwaitlist.joinedwaitlist.notifiedwaitlist.removedbooking.createdbooking.cancelledbooking.rescheduledbooking.ratedflow.completedbooking.updatedbooking.note.createdcalendar.block.createdcalendar.block.deletedcall.incomingcall.statusmessage.editedmessage.deletedcontact.changed_numbernumber.updatednumber.errorflow.status_changedclient.createdclient.updatedclient.suspendednumber.creatednumber.readynumber.disconnectednumber.reconnectedsubscription.createdsubscription.renewed
      • created string (date-time)
      • number string

        Your WhatsApp number.

      • test boolean

        Only on test events (POST .../test): true.

      • data object any keys

        message.status: {message_id, to, status (sent|delivered|read|played|clicked|failed|deleted), timestamp, error {code, message, title, details, error_code, how_to_fix, is_retriable, retry_after_seconds}, sent_by, broadcast_code, whatsapp_status, pricing, callback_data, recipient_user_id, recipient_identity_key_hash, whatsapp}. message.failed: the same data as message.status with status failed. message.received: {message_id, from, from_user_id, media_url, name, type, text, button {text, payload}, in_reply_to, conversation_url, timestamp, context, referral, location, contacts, reaction, interactive, flow, order, identity_key_hash, whatsapp (Meta's message object)}. contact.opted_out: {number, name, source (stop_promotions|whatsapp_stop), detail, timestamp}. broadcast.completed: {code, name, status (completed|cancelled|missed), sent_by, numbers, posted, accepted, errors, skipped_do_not_call, skipped_monthly_limit, status_url, report_url}. usage.threshold: {threshold_percent (80|100), whatsapp_messages {used, limit, left}, plan_messages {whatsapp_sent, emails_sent, total_sent, limit, left}, plan, billing_period {start, end}, timestamp}. template.status_changed: {template {name, language, id}, status (APPROVED|PENDING|REJECTED|PAUSED|DISABLED|COMPONENTS_UPDATED ...), change (a Meta field, or components: the template was edited), previous_value, new_value, components, reason, can_send, timestamp}. conversation.owner_changed: {contact, owner, previous_owner, reason, summary, until, set_by, timestamp}. message.held_for_approval: {approval_id, url, approve_url, recipients, key, summary, expires, timestamp}. approval.resolved: {approval_id, status (approved|rejected|expired), resolved_by, result {status, accepted, failed, broadcast_code}, timestamp}. contact.updated: {contact (a Contact), change (upsert|patch|consent|marketing_resumed), timestamp}. booking.created / booking.cancelled / booking.rescheduled / booking.rated: the Booking object (id, reference, status, contact, contact_name, service {id, name, duration_min}, start, end, timezone, source, calendar {provider, event_id, url, error}, answers, notes, provider {id, name}, rating, payment_status, credits_used, attendance_confirmed, cancelled {at, by, reason}, rescheduled_from_id, link_id, created) plus timestamp; booking.created also hold (true when made from a held time); booking.rescheduled also rescheduled_from {id, reference, start, end}; booking.rated also rated_at. flow.completed: {flow_key, flow_name, contact, contact_name, session_id, answers {field: text}, timestamp}. booking.updated: the Booking object plus changed [name | email | notes | answers | provider] and updated_by. booking.note.created: the Note {id, contact, appointment_id, booking_reference, body, author, author_kind, pinned, created, updated} plus booking {id, reference} (null when on the customer alone). calendar.block.created / calendar.block.deleted: the Block {id, provider_id, title, notes, start, end, start_local, end_local, source, created_by, created, updated} plus by. booking.paid / booking.refunded: the Booking object plus payment {the Payment}; booking.refunded also refund {amount, amount_label, full, by}. payment.paid: {payment, timestamp}. package.purchased: {purchase, payment, granted, timestamp}. poll.voted: {poll_id, title, name, contact, email, choices, comment}. poll.closed: {poll_id, title, status closed | booked, chosen_option, appointment_id, by}. booking.customer.erased: {contact, counts}. submission.created / submission.files_ready / submission.updated / submission.status_changed / submission.assigned / submission.note_added / submission.customer_replied / submission.deleted: the Submission object (id, reference, form {key, name}, channel, status, status_name, status_kind, status_color, priority, tags, due, assignee {id, name}, contact {identity, name, phone, email, verified}, conversation_id, answers {field: value}, extra, location, parent, summary, files_count, files_pending, unread, link, created, updated, status_changed, closed, files, buttons); submission.updated, submission.status_changed and submission.assigned also change {status {from, to}, assignee {from, to}, answers, priority, tags, due, location, files {added}, verified, note, by}; submission.note_added also note and by; submission.customer_replied also reply {text, files, button, followup}; submission.deleted also erased (an erased submission keeps only id, reference, form, channel, status, status_kind, created). submit.automation_failed: the Submission object (without files and buttons) plus automation {id, name}, step, error. waitlist.joined: {id, reference, status, service_id, service_name, provider_id, provider_name, date, date_label, slot_id, time_label, contact, contact_name, contact_email, seats, source, notified_count, notified_at, appointment_id, note, created, updated, day, slot_local, contact_masked, created_at, by, timestamp}. waitlist.notified: {id, reference, status, service_id, service_name, provider_id, provider_name, date, date_label, slot_id, time_label, contact, contact_name, contact_email, seats, source, notified_count, notified_at, appointment_id, note, created, updated, day, slot_local, contact_masked, created_at, offer, timestamp}. waitlist.removed: {id, reference, status, service_id, service_name, provider_id, provider_name, date, date_label, slot_id, time_label, contact, contact_name, contact_email, seats, source, notified_count, notified_at, appointment_id, note, created, updated, day, slot_local, contact_masked, created_at, by, timestamp}. call.incoming: {call_id, status, direction, event, from, from_user_id, to, to_user_id, contact, session, start_time, end_time, duration_seconds, biz_opaque_callback_data, error, recording, transcription, timestamp, whatsapp}. call.status: {call_id, status, direction, event, from, from_user_id, to, to_user_id, contact, session, start_time, end_time, duration_seconds, biz_opaque_callback_data, error, recording, transcription, timestamp, whatsapp}. message.edited: {message_id, original_message_id, from, from_user_id, name, type, text, message, conversation_url, timestamp, whatsapp}. message.deleted: {message_id, original_message_id, from, from_user_id, name, conversation_url, timestamp, whatsapp}. contact.changed_number: {change, previous, new, name, body, message_id, conversation_url, timestamp, whatsapp}. number.updated: {change, previous_value, new_value, details, next_step, whatsapp_field, timestamp}. number.error: {code, title, message, details, href, error_code, how_to_fix, is_retriable, retry_after_seconds, timestamp}. flow.status_changed: {flow_id, change, event, old_status, new_status, message, warning, alert_state, threshold, error_rate, p50_latency, p90_latency, availability, requests_count, errors, timestamp}. client.created: {client, source, changes, timestamp}. client.updated: {client, source, changes, timestamp}. client.suspended: {client, source, changes, timestamp}. number.created: {number, client_id, timestamp, name, display_number, service_status, plan}. number.ready: {number, client_id, timestamp, name, service_status, plan}. number.disconnected: {number, client_id, timestamp, reason, next_step, details}. number.reconnected: {number, client_id, timestamp, reason, details}. subscription.created: {subscription, timestamp}. subscription.renewed: {subscription, timestamp}. subscription.payment_failed: {subscription, timestamp}. subscription.cancelled: {subscription, timestamp}. trial.ending: {number, client_id, timestamp, trial_ends_at, days_left, plan_messages}. trial.expired: {number, client_id, timestamp, trial_ended_at, service_status}. plan.limit_reached: {number, client_id, timestamp, plan, plan_messages, billing_period}. api_key.created: {number, client_id, timestamp, key, created_by}. api_key.revoked: {number, client_id, timestamp, key, revoked_by}. order.created: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp}. order.paid: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp}. order.accepted: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp}. order.ready: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp}. order.completed: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp, handover}. order.cancelled: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp, cancelled}. order.refunded: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp, refund}. order.no_show: {reference, status, source, fulfilment, asap, due, customer, items, items_count, currency, subtotal, discount, discount_code, delivery_fee, fees, tip, tax, total, total_label, refunded, payment, delivery, note, allergy_note, pickup_code, created, timestamp, no_show}. ticket.order.confirmed: {order, timestamp}. ticket.order.refunded: {order, refund, timestamp}. ticket.checked_in: {ticket, order, check_in, timestamp}. ticket.passed_on: {ticket, previous_ticket_id, order, timestamp}. ticket.event.sold_out: {event, date, sold, timestamp}. ticket.event.cancelled: {event, date, scope, refund, reason, orders, tickets, refunded, refunded_label, refunds_failed, timestamp}. ticket.waitlist.joined: {entry, event, timestamp}. ticket.buyer.erased: {contact, counts, timestamp}. ping: {webhook_id, message}.

    • next_attempt_at string (date-time)

      When the next try is planned, while one is (tries after 10 s, 1 min, 5 min, 30 min, 1, 2, 4, 8, 16 h).

Errors

  • 401 Missing, invalid, revoked or expired API key.
  • 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
  • 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
  • 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
  • 500 Unexpected error on app2email's side.
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.