Arccos Golf Webhooks API

openapi: 3.2.0
info:
  title: Arccos Golf Webhooks API
  version: '1'
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: arccos-golf-on-course-data-api-openapi.yml, arccos-golf-webhooks-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.arccosgolf.com/
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Webhooks
paths:
  /v5/webhooks:
    get:
      summary: Get Webhooks
      description: "Webhook events sent to registered URLs are postRound, patchRound, deleteRound, and accountDisconnected. postRound and patchRound include userId, roundId, courseId, courseVersion, and isEnded. deleteRound includes roundId and userId. accountDisconnected includes eventId, eventVersion, createdAt, userId, clientId, disconnectedAt, and reason=user_disconnected. For accountDisconnected, eventId is the idempotency key for a published webhook event and remains stable across delivery retries of that event. Repeated disconnect actions can produce another event for the same disconnected account, so consumers should also make cleanup idempotent by userId and clientId. Delivery is at-least-once, so consumers should tolerate duplicates and delays and respond with 2xx after durable receipt.\n\n You can use these endpoints to manage your webhooks yourself using basic authentication."
      tags:
      - Webhooks
      operationId: handle_get_webhooks.get./v5/webhooks
      security:
      - BasicAuth: []
      responses:
        '200':
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhooksResponse'
    post:
      summary: Create Webhook
      description: Create Webhook
      tags:
      - Webhooks
      operationId: handle_create_webhook.post./v5/webhooks
      security:
      - BasicAuth: []
      responses:
        '200':
          description: 200 response
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
        description: Body required in the request
        required: true
  /v5/webhooks/{webhookId}:
    delete:
      summary: Delete Webhook
      description: Delete Webhook
      tags:
      - Webhooks
      operationId: handle_delete_webhook.delete./v5/webhooks/{webhookId}
      security:
      - BasicAuth: []
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 response
components:
  schemas:
    Webhook:
      properties:
        id:
          title: Webhook.id
          type: number
        webhookUrl:
          title: Webhook.webhookUrl
          type: string
      required:
      - id
      - webhookUrl
      additionalProperties: false
      title: Webhook
      type: object
    CreateWebhookRequest:
      properties:
        webhookUrl:
          title: CreateWebhookRequest.webhookUrl
          type: string
      required:
      - webhookUrl
      additionalProperties: false
      title: CreateWebhookRequest
      type: object
    GetWebhooksResponse:
      items:
        $ref: '#/components/schemas/Webhook'
        title: GetWebhooksResponse.[]
      title: GetWebhooksResponse.[]
      type: array
  securitySchemes:
    AccessCodeAuth:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            openid: Required for all endpoints that have userId in the path
            arccos/read:users: Grants read users access
            arccos/read:rounds: Grants read rounds access
            arccos/read:clubs: Grants read clubs access
          authorizationUrl: https://signin.arccosgolf.com/login
          tokenUrl: https://api.arccosgolf.com/oauth2/token
    BasicAuth:
      type: http
      scheme: basic
x-refined-from:
- arccos-golf-on-course-data-api-openapi.yml
- arccos-golf-webhooks-api-openapi.yml