Skip to main content

Webhooks

Adspire.AI stores incoming connector events via the Webhook Events API. Connectors normalize provider payloads and forward them to Adspire.AI.

Create webhook event​

POST /api/webhook-events

Required fields​

  • event_type (string): provider.topic (example: shopify.orders/create)
  • payload (object): provider payload with _meta appended

Optional fields​

  • connector_installation_id (integer)
  • status (string)
  • response (string)
  • attempts (integer)
  • sent_at (date-time)
  • next_retry_at (date-time)

Example body​

{
  "event_type": "shopify.orders/create",
  "payload": {
    "id": 123,
    "total_price": "29.99",
    "_meta": {
      "source": "shopify",
      "topic": "orders/create",
      "shop": "demo.myshopify.com",
      "received_at": "2024-01-01T12:00:00Z",
      "request_id": "uuid"
    }
  }
}

Normalization guidelines​

  • Use event_type as <provider>.<topic>.
  • Copy provider payload as-is, then append _meta for traceability.
  • Include identifiers in _meta (request_id, shop, etc.) when available.