Increase Event Subscriptions API

openapi: 3.1.0
info:
  description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
  title: Increase Account Numbers Event Subscriptions API
  version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).
  name: Event Subscriptions
paths:
  /event_subscriptions:
    get:
      operationId: list_event_subscriptions
      parameters:
      - in: query
        name: cursor
        required: false
        schema:
          description: Return the page of entries after this one.
          type: string
          x-documentation-priority: low
      - in: query
        name: limit
        required: false
        schema:
          description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
          minimum: 1
          type: integer
          x-documentation-priority: low
      - in: query
        name: idempotency_key
        required: false
        schema:
          description: Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
          maxLength: 200
          minLength: 1
          type: string
          x-documentation-priority: default
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_subscription_list'
          description: Event Subscription List
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: List Event Subscriptions
      x-sandbox-only: false
      x-tag: Event Subscriptions
      tags:
      - Event Subscriptions
    post:
      operationId: create_an_event_subscription
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_an_event_subscription_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_subscription'
          description: Event Subscription
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Create an Event Subscription
      x-sandbox-only: false
      x-tag: Event Subscriptions
      tags:
      - Event Subscriptions
  /event_subscriptions/{event_subscription_id}:
    get:
      operationId: retrieve_an_event_subscription
      parameters:
      - example: event_subscription_001dzz0r20rcdxgb013zqb8m04g
        in: path
        name: event_subscription_id
        required: true
        schema:
          description: The identifier of the Event Subscription.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Event Subscriptions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_subscription'
          description: Event Subscription
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Retrieve an Event Subscription
      x-sandbox-only: false
      x-tag: Event Subscriptions
      tags:
      - Event Subscriptions
    patch:
      operationId: update_an_event_subscription
      parameters:
      - example: event_subscription_001dzz0r20rcdxgb013zqb8m04g
        in: path
        name: event_subscription_id
        required: true
        schema:
          description: The identifier of the Event Subscription.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Event Subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_an_event_subscription_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_subscription'
          description: Event Subscription
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Update an Event Subscription
      x-sandbox-only: false
      x-tag: Event Subscriptions
      tags:
      - Event Subscriptions
components:
  schemas:
    event_subscription_list:
      additionalProperties: true
      description: A list of Event Subscription objects.
      example:
        data:
        - created_at: '2020-01-31T23:59:59Z'
          id: event_subscription_001dzz0r20rcdxgb013zqb8m04g
          idempotency_key: null
          oauth_connection_id: null
          selected_event_categories: null
          status: active
          type: event_subscription
          url: https://website.com/webhooks
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: '#/components/schemas/event_subscription'
          type: array
          x-documentation-priority: default
        next_cursor:
          anyOf:
          - description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
            type: string
            x-documentation-priority: default
          - type: 'null'
      required:
      - data
      - next_cursor
      title: Event Subscription List
      type: object
      x-event-categories: []
      x-stainless-empty-object: false
      x-title-plural: Event Subscription Lists
    update_an_event_subscription_parameters:
      additionalProperties: false
      example: {}
      properties:
        status:
          description: The status to update the Event Subscription with.
          enum:
          - active
          - disabled
          - deleted
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - The subscription is active and Events will be delivered normally.
          - The subscription is temporarily disabled and Events will not be delivered.
          - The subscription is permanently disabled and Events will not be delivered.
      type: object
      x-event-categories: []
      x-stainless-empty-object: false
    error:
      anyOf:
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 404
            type: integer
          title:
            type: string
          type:
            enum:
            - api_method_not_found_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 403
            type: integer
          title:
            type: string
          type:
            enum:
            - environment_mismatch_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          resource_id:
            description: ''
            type: string
            x-documentation-priority: default
          status:
            enum:
            - 409
            type: integer
          title:
            type: string
          type:
            enum:
            - idempotency_key_already_used_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        - resource_id
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 403
            type: integer
          title:
            type: string
          type:
            enum:
            - insufficient_permissions_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 500
            type: integer
          title:
            type: string
          type:
            enum:
            - internal_server_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          reason:
            description: ''
            enum:
            - deleted_credential
            - expired_credential
            - ip_not_allowed
            - no_credential
            - no_header
            - no_api_access
            - wrong_environment
            type: string
            x-documentation-priority: default
            x-enum-descriptions:
            - deleted_credential
            - expired_credential
            - ip_not_allowed
            - no_credential
            - no_header
            - no_api_access
            - wrong_environment
          status:
            enum:
            - 401
            type: integer
          title:
            type: string
          type:
            enum:
            - invalid_api_key_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        - reason
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 409
            type: integer
          title:
            type: string
          type:
            enum:
            - invalid_operation_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          errors:
            description: All errors related to parsing the request parameters.
            items:
              additionalProperties: true
              properties: {}
              title: ErrorsElement
              type: object
              x-event-categories: []
              x-stainless-empty-object: false
              x-title-plural: ErrorsElements
            type: array
            x-documentation-priority: default
          status:
            enum:
            - 400
            type: integer
          title:
            type: string
          type:
            enum:
            - invalid_parameters_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        - errors
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 400
            type: integer
          title:
            type: string
          type:
            enum:
            - malformed_request_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 404
            type: integer
          title:
            type: string
          type:
            enum:
            - object_not_found_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 403
            type: integer
          title:
            type: string
          type:
            enum:
            - private_feature_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          retry_after:
            anyOf:
            - description: ''
              type: integer
              x-documentation-priority: default
            - type: 'null'
          status:
            enum:
            - 429
            type: integer
          title:
            type: string
          type:
            enum:
            - rate_limited_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
    event_subscription:
      additionalProperties: true
      description: Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).
      example:
        created_at: '2020-01-31T23:59:59Z'
        id: event_subscription_001dzz0r20rcdxgb013zqb8m04g
        idempotency_key: null
        oauth_connection_id: null
        selected_event_categories: null
        status: active
        type: event_subscription
        url: https://website.com/webhooks
      properties:
        created_at:
          description: The time the event subscription was created.
          format: date-time
          type: string
          x-documentation-priority: default
        id:
          description: The event subscription identifier.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Event Subscriptions
        idempotency_key:
          anyOf:
          - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
            type: string
            x-documentation-priority: default
          - type: 'null'
        oauth_connection_id:
          anyOf:
          - description: If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.
            type: string
            x-documentation-priority: default
            x-id-reference-to: OAuth Connections
          - type: 'null'
        selected_event_categories:
          anyOf:
          - description: If specified, this subscription will only receive webhooks for Events with the specified `category`.
            items:
              additionalProperties: false
              properties:
                event_category:
                  anyOf:
                  - description: The category of the Event.
                    enum:
                    - account.created
                    - account.updated
                    - account_number.created
                    - account_number.updated
                    - account_statement.created
                    - account_transfer.created
                    - account_transfer.updated
                    - ach_prenotification.created
                    - ach_prenotification.updated
                    - ach_transfer.created
                    - ach_transfer.updated
                    - blockchain_address.created
                    - blockchain_address.updated
                    - blockchain_offramp_transfer.created
                    - blockchain_offramp_transfer.updated
                    - blockchain_onramp_transfer.created
                    - blockchain_onramp_transfer.updated
                    - bookkeeping_account.created
                    - bookkeeping_account.updated
                    - bookkeeping_entry_set.updated
                    - card.created
                    - card.updated
                    - card_payment.created
                    - card_payment.updated
                    - card_purchase_supplement.created
                    - card_profile.created
                    - card_profile.updated
                    - card_dispute.created
                    - card_dispute.updated
                    - check_deposit.created
                    - check_deposit.updated
                    - check_transfer.created
                    - check_transfer.updated
                    - declined_transaction.created
                    - digital_card_profile.created
                    - digital_card_profile.updated
                    - digital_wallet_token.created
                    - digital_wallet_token.updated
                    - entity.created
                    - entity.updated
                    - event_subscription.created
                    - event_subscription.updated
                    - export.created
                    - export.updated
                    - external_account.created
                    - external_account.updated
                    - fednow_transfer.created
                    - fednow_transfer.updated
                    - file.created
                    - group.updated
                    - group.heartbeat
                    - inbound_ach_transfer.created
                    - inbound_ach_transfer.updated
                    - inbound_ach_transfer_return.created
                    - inbound_ach_transfer_return.updated
                    - inbound_check_deposit.created
                    - inbound_check_deposit.updated
                    - inbound_fednow_transfer.created
                    - inbound_fednow_transfer.updated
                    - inbound_mail_item.created
                    - inbound_mail_item.updated
                    - inbound_real_time_payments_transfer.created
                    - inbound_real_time_payments_transfer.updated
                    - inbound_wire_drawdown_request.created
                    - inbound_wire_transfer.created
                    - inbound_wire_transfer.updated
                    - intrafi_account_enrollment.created
                    - intrafi_account_enrollment.updated
                    - intrafi_exclusion.created
                    - intrafi_exclusion.updated
                    - lockbox.created
                    - lockbox.updated
                    - oauth_connection.created
                    - oauth_connection.deactivated
                    - card_push_transfer.created
                    - card_push_transfer.updated
                    - card_validation.created
                    - card_validation.updated
                    - pending_transaction.created
                    - pending_transaction.updated
                    - physical_card.created
                    - physical_card.updated
                    - physical_card_profile.created
                    - physical_card_profile.updated
                    - physical_check.created
                    - physical_check.updated
                    - program.created
                    - program.updated
                    - proof_of_authorization_request.created
                    - proof_of_authorization_request.updated
                    - real_time_decision.card_authorization_requested
                    - real_time_decision.card_balance_inquiry_requested
                    - real_time_decision.digital_wallet_token_requested
                    - real_time_decision.digital_wallet_authentication_requested
                    - real_time_decision.card_authentication_requested
                    - real_time_decision.card_authentication_challenge_requested
                    - real_time_payments_transfer.created
                    - real_time_payments_transfer.updated
                    - real_time_payments_request_for_payment.created
                    - real_time_payments_request_for_payment.updated
                    - swift_transfer.created
                    - swift_transfer.updated
                    - transaction.created
                    - wire_drawdown_request.created
                    - wire_drawdown_request.updated
                    - wire_transfer.created
                    - wire_transfer.updated
                    type: string
                    x-documentation-priority: default
                    x-enum-descriptions:
                    - Occurs whenever an Account is created.
                    - Occurs whenever an Account is updated.
                    - Occurs whenever an Account Number is created.
                    - Occurs whenever an Account Number is updated.
                    - Occurs whenever an Account Statement is created.
                    - Occurs whenever an Account Transfer is created.
                    - Occurs whenever an Account Transfer is updated.
                    - Occurs whenever an ACH Prenotification is created.
                    - Occurs whenever an ACH Prenotification is updated.
                    - Occurs whenever an ACH Transfer is created.
                    - Occurs whenever an ACH Transfer is updated.
                    - Occurs whenever a Blockchain Address is created.
                    - Occurs whenever a Blockchain Address is updated.
                    - Occurs whenever a Blockchain Off-Ramp Transfer is created.
                    - Occurs whenever a Blockchain Off-Ramp Transfer is updated.
                    - Occurs whenever a Blockchain On-Ramp Transfer is created.
                    - Occurs whenever a Blockchain On-Ramp Transfer is updated.
                    - Occurs whenever a Bookkeeping Account is created.
                    - Occurs whenever a Bookkeeping Account is updated.
                    - Occurs whenever a Bookkeeping Entry Set is created.
                    - Occurs whenever a Card is created.
                    - Occurs whenever a Card is updated.
                    - Occurs whenever a Card Payment is created.
                    - Occurs whenever a Card Payment is updated.
                    - Occurs whenever a Card Purchase Supplement is created.
                    - Occurs whenever a Card Profile is created.
                    - Occurs whenever a Card Profile is updated.
                    - Occurs whenever a Card Dispute is created.
                    - Occurs whenever a Card Dispute is updated.
                    - Occurs whenever a Check Deposit is created.
                    - Occurs whenever a Check Deposit is updated.
                    - Occurs whenever a Check Transfer is created.
                    - Occurs whenever a Check Transfer is updated.
                    - Occurs whenever a Declined Transaction is created.
                    - Occurs whenever a Digital Card Profile is created.
                    - Occurs whenever a Digital Card Profile is updated.
                    - Occurs whenever a Digital Wallet Token is created.
                    - Occurs whenever a Digital Wallet Token is updated.
                    - Occurs whenever an Entity is created.
                    - Occurs whenever an Entity is updated.
                    - Occurs whenever an Event Subscription is created.
                    - Occurs whenever an Event Subscription is updated.
                    - Occurs whenever an Export is created.
                    - Occurs whenever an Export is updated.
                    - Occurs whenever an External Account is created.
                    - Occurs whenever an External Account is updated.
                    - Occurs whenever a FedNow Transfer is created.
                    - Occurs whenever a FedNow Transfer is updated.
                    - Occurs whenever a File is created.
                    - Occurs whenever a Group is updated.
                    - Increase may send webhooks with this category to see if a webhook endpoint is working properly.
                    - Occurs whenever an Inbound ACH Transfer is created.
                    - Occurs whenever an Inbound ACH Transfer is updated.
                    - Occurs whenever an Inbound ACH Transfer Return is created.
                    - Occurs whenever an Inbound ACH Transfer Return is updated.
                    - Occurs whenever an Inbound Check Deposit is created.
                    - Occurs whenever an Inbound Check Deposit is updated.
                    - Occurs whenever an Inbound FedNow Transfer is created.
                    - Occurs whenever an Inbound FedNow Transfer is updated.
                    - Occurs whenever an Inbound Mail Item is created.
                    - Occurs whenever an Inbound Mail Item is updated.
                    - Occurs whenever an Inbound Real-Time Payments Transfer is created.
                    - Occurs whenever an Inbound Real-Time Payments Transfer is updated.
                    - Occurs whenever an Inbound Wire Drawdown Request is created.
                    - Occurs whenever an Inbound Wire Transfer is created.
                    - Occurs whenever an Inbound Wire Transfer is updated.
                    - Occurs whenever an IntraFi Account Enrollment is created.
                    - Occurs whenever an IntraFi Account Enrollment is updated.
                    - Occurs whenever an IntraFi Exclusion is created.
                    - Occurs whenever an IntraFi Exclusion is updated.
                    - Occurs whenever a Lockbox is created.
                    - Occurs whenever a Lockbox is updated.
                    - Occurs whenever an OAuth Connection is created.
                    - Occurs whenever an OAuth Connection is deactivated.
                    - Occurs whenever a Card Push Transfer is created.
                    - Occurs whenever a Card Push Transfer is updated.
                    - Occurs whenever a Card Validation is created.
                    - Occurs whenever a Card Validation is updated.
                    - Occurs whenever a Pending Transaction is created.
                    - Occurs whenever a Pending Transaction is updated.
                    - Occurs whenever a Physical Card is created.
                    - Occurs whenever a Physical Card is updated.
                    - Occurs whenever a Physical Card Profile is created.
                    - Occurs whenever a Physical Card Profile is updated.
                    - Occurs whenever a Physical Check is created.
                    - Occurs whenever a Physical Check is updated.
                    - Occurs whenever a Program is created.
                    - Occurs whenever a Program is updated.
                    - Occurs whenever a Proof of Authorization Request is created.
                    - Occurs whenever a Proof of Authorization Request is updated.
                    - Occurs whenever a Real-Time Decision is created in response to a card authorization.
                    - Occurs whenever a Real-Time Decision is created in response to a card balance inquiry.
                    - Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.
                    - Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.
                    - Occurs whenever a Real-Time Decision is created in response to 3DS authentication.
                    - Occurs whenever a Real-Time Decision is created in response to 3DS authentication challenges.
                    - Occurs whenever a Real-Time Payments Transfer is created.
                    - Occurs whenever a Real-Time Payments Transfer is updated.
                    - Occurs whenever a Real-Time Payments Request for Payment is created.
                    - Occurs whenever a Real-Time Payments Request for Payment is updated.
                    - Occurs whenever a Swift Transfer is created.
                    - Occurs whenever a Swift Transfer is updated.
                    - Occurs whenever a Transaction is created.
                    - Occurs whenever a Wire Drawdown Request is created.
                    - Occurs whenever a Wire Drawdown Request is updated.
                    - Occurs whenever a Wire Transfer is created.
                    - Occurs whenever a Wire Transfer is updated.
                  - type: 'null'
              required:
              - event_category
              title: Event Subscription SelectedEventCategoriesElement
              type: object
              x-event-categories: []
              x-stainless-empty-object: false
              x-title-plural: SelectedEventCategoriesElements
            type: array
            x-documentation-priority: default
          - type: 'null'
        status:
          description: This indicates if we'll send notifications to this subscription.
          enum:
          - active
          - disabled
          - deleted
          - requires_attention
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - The subscription is active and Events will be delivered normally.
          - The subscription is temporarily disabled and Events will not be delivered.
          - The subscription is permanently disabled and Events will not be delivered.
          - The subscription is temporarily disabled due to delivery errors and Events will not be delivered.
        type:
          description: A constant representing the object's type. For this resource it will always be `event_subscription`.
          enum:
          - event_subscription
          type: string
          x-documentation-priority: default
        url:
          description: The webhook url where we'll send notifications.
          type: string
          x-documentation-priority: default
      required:
      - type
      - id
      - created_at
      - status
      - selected_event_categories
      - oauth_connection_id
      - url
      - idempotency_key
      title: Event Subscription
      type: object
      x-event-categories:
      - event_subscription.created
      - event_subscription.updated
      x-stainless-empty-object: false
      x-tag: Event Subscriptions
      x-title-plural: Event Subscriptions
    create_an_event_subscription_parameters:
      additionalProperties: true
      example:
        url: https://website.com/webhooks
      properties:
        oauth_connection_id:
          description: If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection.
          maxLength: 200
          minLength: 1
          type: string
          x-documentation-priority: default
        selected_event_categories:
          description: If specified, this subscription will only receive webhooks for Events with the specified `category`. If specifying a Real-Time Decision event category, 

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-event-subscriptions-api-openapi.yml