openapi: 3.2.0
info:
  title: Rollee Webhooks API
  contact: {}
  version: '1.0'
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: rollee-company-api-openapi.yml, rollee-user-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getrollee.com/api/company/v0.5
- url: https://api.getrollee.com/api/v0.5
tags:
- name: Webhooks
paths:
  /company/v0.5/webhooks/accounts:
    put:
      description: Call to configure your Webhooks and receive Rollee's Events for your Company Accounts. Please contact Rollee team if you're planning to use Webhooks.
      tags:
      - Webhooks
      summary: Webhook configuration for Company Accounts Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/models.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: Success status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putCompanyV05WebhooksAccounts
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/company/v0.5
  /company/v0.5/webhooks/endpoints:
    put:
      description: Call to configure your Webhooks and receive notifications as soon as new data has been fetched for a specific company account. Please contact Rollee team if you're planning to use Webhooks.
      tags:
      - Webhooks
      summary: Webhook configuration for Endpoint Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/models.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putCompanyV05WebhooksEndpoints
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/company/v0.5
  /company/v0.5/webhooks/multi_endpoints:
    put:
      description: Call to configure your Webhooks and receive notifications as soon as data from several different endpoints is fetched. Please bear in mind that this is a full replace operation for the webhook attributes, so you need to provide all the parameters.
      tags:
      - Webhooks
      summary: Webhook configuration for Multi Endpoint Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/models.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putCompanyV05WebhooksMultiEndpoints
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/company/v0.5
  /webhooks:
    get:
      description: List all the webhooks that are currently configured (both enabled and disabled ones)
      tags:
      - Webhooks
      summary: Lists configured webhooks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhooks.ConfiguredWebhook'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getWebhooks
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/company/v0.5
  /webhooks/accounts:
    put:
      description: Call to configure webhooks and receive Rollee's Events for the users' accounts. Please bear in mind that this is a full replace operation for the webhook attributes, so you need to provide all the parameters.
      tags:
      - Webhooks
      summary: Webhook configuration for Accounts Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/webhooks.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putWebhooksAccounts
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /webhooks/endpoints:
    put:
      description: Call to configure your Webhooks and receive notifications as soon as new data has been fetched for a specific account. Please bear in mind that this is a full replace operation for the webhook attributes, so you need to provide all the parameters.
      tags:
      - Webhooks
      summary: Webhook configuration for Endpoint Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/webhooks.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putWebhooksEndpoints
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /webhooks/multi_endpoints:
    put:
      description: Call to configure your Webhooks and receive notifications as soon as data from several different endpoints is fetched. Please bear in mind that this is a full replace operation for the webhook attributes, so you need to provide all the parameters.
      tags:
      - Webhooks
      summary: Webhook configuration for Multi Endpoint Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/webhooks.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putWebhooksMultiEndpoints
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /webhooks/rollee_connect_events:
    put:
      description: Call to configure your Webhooks and receive notifications for each rollee connect event. Please bear in mind that this is a full replace operation for the webhook attributes, so you need to provide all the parameters.
      tags:
      - Webhooks
      summary: Webhook configuration for Rollee Connect Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/webhooks.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putWebhooksRolleeConnectEvents
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /webhooks/users:
    put:
      description: Call to configure your Webhooks and receive Rollee's Events for your Users. Please bear in mind that this is a full replace operation for the webhook attributes, so you need to provide all the parameters (even optionals if these were set before and want to keep them).
      tags:
      - Webhooks
      summary: Webhook configuration for Users Events
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/webhooks.CreateOrUpdateWebhookHandlerParams'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: putWebhooksUsers
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /webhooks/{type}:
    delete:
      description: Delete a particular webhook configuration (can be accounts, users, rollee_connect_events, endpoints or multi_endpoints)
      tags:
      - Webhooks
      summary: Delete a webhook configuration
      parameters:
      - description: Bearer <JWT token>
        name: Authorization
        in: header
        required: true
        schema:
          type: string
      - description: webhook type
        name: type
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhooks.ConfiguredWebhook'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: deleteWebhooksByType
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
  /webhooks_v2:
    get:
      description: List all the webhooks that are currently configured (both enabled and disabled ones)
      tags:
      - Webhooks
      summary: Lists configured webhooks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/webhooks.ConfiguredWebhook'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ServerError'
      operationId: getWebhooksV2
      x-operation-id-source: derived
    servers:
    - url: https://api.getrollee.com/api/v0.5
components:
  requestBodies:
    models.CreateOrUpdateWebhookHandlerParams:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/models.CreateOrUpdateWebhookHandlerParams'
      description: webhook parameters
      required: true
    webhooks.CreateOrUpdateWebhookHandlerParams:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/webhooks.CreateOrUpdateWebhookHandlerParams'
      description: webhook parameters
      required: true
  schemas:
    models.StatusResponse:
      type: object
      properties:
        status:
          description: Status will always be "success"
          type: string
          example: success
    models.WebhookHeader:
      type: object
      additionalProperties: {}
    models.CreateOrUpdateWebhookHandlerParams:
      type: object
      required:
      - enabled
      - method
      - url
      properties:
        enabled:
          type: boolean
        headers:
          description: optional key/value object corresponding to the headers that will be sent in the webhook request
          allOf:
          - $ref: '#/components/schemas/models.WebhookHeader'
        method:
          description: http method POST or PUT
          type: string
        platform_ids:
          type: array
          items:
            type: string
        secret:
          description: optional secret for Rollee to compute a signature (HMAC SHA-512, base64 encoded) and send it in the X-Signature header
          type: string
        url:
          description: fully qualified url that will receive webhooks data
          type: string
    models.ServerError:
      type: object
      properties:
        error:
          type: string
    webhooks.ConfiguredWebhook:
      type: object
      required:
      - enabled
      - method
      - url
      properties:
        enabled:
          type: boolean
        headers:
          description: optional key/value object corresponding to the headers that will be sent in the webhook request
          allOf:
          - $ref: '#/components/schemas/models.WebhookHeader'
        kind:
          description: the type of event that triggers the webhook
          type: string
        method:
          description: http method POST or PUT
          type: string
        platform_ids:
          type: array
          items:
            type: string
        secret:
          description: optional secret for Rollee to compute a signature (HMAC SHA-512, base64 encoded) and send it in the X-Signature header
          type: string
        type:
          type: string
        url:
          description: fully qualified url that will receive webhooks data
          type: string
    webhooks.CreateOrUpdateWebhookHandlerParams:
      type: object
      required:
      - enabled
      - method
      - url
      properties:
        enabled:
          type: boolean
        headers:
          description: optional key/value object corresponding to the headers that will be sent in the webhook request
          allOf:
          - $ref: '#/components/schemas/models.WebhookHeader'
        method:
          description: http method POST or PUT
          type: string
        platform_ids:
          type: array
          items:
            type: string
        secret:
          description: optional secret for Rollee to compute a signature (HMAC SHA-512, base64 encoded) and send it in the X-Signature header
          type: string
        url:
          description: fully qualified url that will receive webhooks data
          type: string
x-refined-from:
- rollee-company-api-openapi.yml
- rollee-user-api-openapi.yml
x-provenance:
  method: searched
  source: https://developers.getrollee.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.getrollee.com/reference/delete_companies-id.md
  - https://developers.getrollee.com/reference/get_companies-id-company-accounts.md
  - https://developers.getrollee.com/reference/get_companies-id.md
  - https://developers.getrollee.com/reference/get_companies.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-absences.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-activity.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-banking-info.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-documents.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-employees.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-employment.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-income.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-performance.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-profiles.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-trips.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-vehicles.md
  - https://developers.getrollee.com/reference/get_company-accounts-id-wallet.md
  - https://developers.getrollee.com/reference/get_company-accounts-id.md
  - https://developers.getrollee.com/reference/get_token-refresh.md
  - https://developers.getrollee.com/reference/get_users-id.md
  - https://developers.getrollee.com/reference/get_webhooks-1.md
  - https://developers.getrollee.com/reference/post_companies.md
  - https://developers.getrollee.com/reference/post_company-accounts-id-reconnect.md
  - https://developers.getrollee.com/reference/post_sessions-session-refresh.md
  - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-accounts.md
  - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-endpoints.md
  - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-multi-endpoints.md
  - https://developers.getrollee.com/reference/put_users-id.md
  merge:
    pages: 27
    deduped: 49
    conflicts_kept_first: 0