openapi: 3.1.0
info:
  title: Commerce Layer addresses event_callbacks API
  version: 7.10.1
  contact:
    name: API Support
    url: https://commercelayer.io
    email: support@commercelayer.io
  description: Headless Commerce for Global Brands.
servers:
- url: https://{your_organization_slug}.commercelayer.io/api
  description: API
- url: https://core.commercelayer.io/users/sign_in
  description: Sign in
- url: https://docs.commercelayer.io/api
  description: API reference
security:
- bearerAuth: []
tags:
- name: event_callbacks
  description: resource type
paths:
  /event_callbacks:
    get:
      operationId: GET/event_callbacks
      summary: List all event callbacks
      description: List all event callbacks
      tags:
      - event_callbacks
      responses:
        '200':
          description: A list of event callback objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/eventCallbackResponseList'
  /event_callbacks/{eventCallbackId}:
    get:
      operationId: GET/event_callbacks/eventCallbackId
      summary: Retrieve an event callback
      description: Retrieve an event callback
      tags:
      - event_callbacks
      parameters:
      - name: eventCallbackId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The event callback object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/eventCallbackResponse'
  /events/{eventId}/last_event_callbacks:
    get:
      operationId: GET/eventId/last_event_callbacks
      summary: Retrieve the last event callbacks associated to the event
      description: Retrieve the last event callbacks associated to the event
      tags:
      - event_callbacks
      parameters:
      - name: eventId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The last_event_callbacks associated to the event
  /webhooks/{webhookId}/last_event_callbacks:
    get:
      operationId: GET/webhookId/last_event_callbacks
      summary: Retrieve the last event callbacks associated to the webhook
      description: Retrieve the last event callbacks associated to the webhook
      tags:
      - event_callbacks
      parameters:
      - name: webhookId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The last_event_callbacks associated to the webhook
components:
  schemas:
    eventCallbackResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            type:
              type: string
              description: The resource's type
              enum:
              - event_callbacks
            links:
              type: object
              properties:
                self:
                  type: string
                  description: URL
            attributes:
              $ref: '#/components/schemas/eventCallback/properties/data/properties/attributes'
            relationships:
              type: object
              properties:
                webhook:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - webhook
                        id:
                          type: string
                          description: The resource ID
                event_stores:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: The resource ID
    eventCallback:
      properties:
        data:
          properties:
            attributes:
              type: object
              properties:
                callback_url:
                  type: string
                  description: The URI of the callback, inherited by the associated webhook.
                  example: https://yourapp.com/webhooks
                  nullable: false
                payload:
                  type: object
                  description: The payload sent to the callback endpoint, including the event affected resource and the specified includes.
                  example:
                    data:
                      attributes:
                        id: PYWehaoXJj
                        type: orders
                  nullable: true
                response_code:
                  type: string
                  description: The HTTP response code of the callback endpoint.
                  example: '200'
                  nullable: true
                response_message:
                  type: string
                  description: The HTTP response message of the callback endpoint.
                  example: OK
                  nullable: true
                created_at:
                  type: string
                  description: Time at which the resource was created.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                updated_at:
                  type: string
                  description: Time at which the resource was last updated.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
    eventCallbackResponseList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/eventCallbackResponse/properties/data'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT