# GENERATED by API Evangelist from https://developer.eliq.com/doc/webhooks — Eliq publishes no AsyncAPI.
# generated: 2026-09-06
# method: generated
# source: https://developer.eliq.com/doc/webhooks
asyncapi: 3.0.0
info:
  title: Eliq Notifications (webhooks)
  version: 1.0.0
  description: GENERATED by API Evangelist from Eliq's published webhook documentation (https://developer.eliq.com/doc/webhooks),
    2026-09-06. Eliq publishes no AsyncAPI document of its own. Every channel, message and field below is transcribed
    from that page; nothing was invented. Payload `object` bodies vary per notification type and are documented,
    not schema'd, by the provider.
  contact:
    name: Eliq B2B Support
    email: support_b2b@eliq.com
defaultContentType: application/json
servers:
  consumer:
    host: '{your-endpoint-host}'
    protocol: https
    description: Eliq POSTs events to an HTTPS endpoint the utility implements and registers with Eliq. There is
      no Eliq-hosted broker.
    variables:
      your-endpoint-host:
        description: The consumer endpoint host.
        default: webhooks.example.com
channels:
  notifications:
    address: /
    title: Eliq notification events
    description: All Eliq webhook events are delivered as HTTP POST with a X-Eliq-Signature header (t=<unix>,sha256=<hmac-sha256
      of "{timestamp}.{json_payload}">).
    messages:
      budget_weekly:
        $ref: '#/components/messages/budget_weekly'
      budget_monthly:
        $ref: '#/components/messages/budget_monthly'
      daily_anomaly:
        $ref: '#/components/messages/daily_anomaly'
      monthly_anomaly:
        $ref: '#/components/messages/monthly_anomaly'
      notifications_market_price_next_day_avg_price_alert:
        $ref: '#/components/messages/notifications_market_price_next_day_avg_price_alert'
      notifications_market_price_next_day_hour_price_alert:
        $ref: '#/components/messages/notifications_market_price_next_day_hour_price_alert'
      monthly_insight:
        $ref: '#/components/messages/monthly_insight'
      connection_action_required:
        $ref: '#/components/messages/connection_action_required'
      connection_first_data_received:
        $ref: '#/components/messages/connection_first_data_received'
operations:
  receiveNotification:
    action: receive
    channel:
      $ref: '#/channels/notifications'
    summary: Receive an Eliq notification event.
    messages:
    - $ref: '#/channels/notifications/messages/budget_weekly'
    - $ref: '#/channels/notifications/messages/budget_monthly'
    - $ref: '#/channels/notifications/messages/daily_anomaly'
    - $ref: '#/channels/notifications/messages/monthly_anomaly'
    - $ref: '#/channels/notifications/messages/notifications_market_price_next_day_avg_price_alert'
    - $ref: '#/channels/notifications/messages/notifications_market_price_next_day_hour_price_alert'
    - $ref: '#/channels/notifications/messages/monthly_insight'
    - $ref: '#/channels/notifications/messages/connection_action_required'
    - $ref: '#/channels/notifications/messages/connection_first_data_received'
components:
  messages:
    budget_weekly:
      name: budget_weekly
      title: Budget Weekly
      summary: A weekly budget completed under budget, exceeded its limit, or is forecast to exceed it.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: budget_weekly
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    budget_monthly:
      name: budget_monthly
      title: Budget Monthly
      summary: A monthly budget completed under budget, exceeded its limit, or is forecast to exceed it.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: budget_monthly
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    daily_anomaly:
      name: daily_anomaly
      title: Daily Anomaly
      summary: Yesterday's consumption for a location was materially lower or higher than expected.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: daily_anomaly
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    monthly_anomaly:
      name: monthly_anomaly
      title: Monthly Anomaly
      summary: A location's consumption for the current month is unusually high.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: monthly_anomaly
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    notifications_market_price_next_day_avg_price_alert:
      name: notifications_market_price_next_day_avg_price_alert
      title: Notifications Market Price Next Day Avg Price Alert
      summary: Next-day average electricity price alert. Generated and sent at 17:00 Stockholm time.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: notifications_market_price_next_day_avg_price_alert
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    notifications_market_price_next_day_hour_price_alert:
      name: notifications_market_price_next_day_hour_price_alert
      title: Notifications Market Price Next Day Hour Price Alert
      summary: Next-day hourly price peak alert. Generated and sent at 17:00 Stockholm time.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: notifications_market_price_next_day_hour_price_alert
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    monthly_insight:
      name: monthly_insight
      title: Monthly Insight
      summary: Summary of last month's energy usage, carrying localised header/content message text. Sent once the
        previous month's consumption is available for the location.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: monthly_insight
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    connection_action_required:
      name: connection_action_required
      title: Connection Action Required
      summary: A meter-data connection changed state and needs the end user to act (e.g. AwaitingConfirmation ->
        Disconnected).
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: connection_action_required
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks
    connection_first_data_received:
      name: connection_first_data_received
      title: Connection First Data Received
      summary: All connection entities have completed their first successful data sync.
      contentType: application/json
      payload:
        type: object
        required:
        - id
        - created_date
        - type
        - object
        properties:
          id:
            type: string
            format: uuid
            description: Event id; dedupe key.
          created_date:
            type: string
            format: date-time
            description: UTC creation timestamp.
          type:
            type: string
            const: notification_created
          object:
            type: object
            required:
            - type
            properties:
              location_id:
                type: integer
              location_ext_ref:
                type: string
              client_id:
                type: integer
              type:
                type: string
                const: connection_first_data_received
              object:
                type: object
                description: Type-specific body; see https://developer.eliq.com/doc/webhooks