find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/getsmileapi:getsmileapi-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Smile Webhooks API
  version: 1.14.0
  description: The Smile API provides employment and income data from a single API.
  contact:
    name: Smile Technology Pte Ltd
    url: https://www.getsmileapi.com
    email: info@getsmileapi.com
  termsOfService: https://www.getsmileapi.com/terms-and-conditions
servers:
- url: https://sandbox.smileapi.io/v1
  description: Sandbox
- url: https://open.smileapi.io/v1
  description: Production
security:
- basicAuth: []
tags:
- name: Webhooks
paths:
  /webhooks:
    parameters: []
    get:
      summary: List Webhooks
      tags:
      - Webhooks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: '1259723474'
                      items:
                      - id: 17bbf36498de4d68a0d4f86c7b62f69f
                        createdAt: '2021-04-14T09:30:24Z'
                        name: Event Notification Postback
                        url: https://webhook.clienturl.xyz
                        eventTypes:
                        - ACCOUNT_CONNECTED
                        active: true
                        secret: a little secret
                        updatedAt: '2021-04-14T09:30:24Z'
      operationId: list-webhooks
      description: List all webhook endpoints.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
    post:
      summary: Create Webhook
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookPostResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      createdAt: '2021-04-14T09:30:24Z'
                      name: Event Notification Postback
                      url: https://webhook.clienturl.xyz
                      eventTypes:
                      - ACCOUNT_CONNECTED
                      secret: a little secret
                      active: true
                      updatedAt: '2021-04-14T09:30:24Z'
      operationId: create-webhook
      description: Create a webhook endpoint.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookPostRequest'
            examples:
              Example:
                value:
                  name: Event Notification Postback
                  url: https://webhook.clienturl.xyz
                  eventTypes:
                  - ACCOUNT_CONNECTED
                  - IDENTITY_ADDED
                  active: true
                  secret: a little secret
      tags:
      - Webhooks
  /webhooks/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: View Webhook
      tags:
      - Webhooks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      createdAt: '2021-04-14T09:30:24Z'
                      name: Event Notification Postback
                      url: https://webhook.clienturl.xyz
                      eventTypes:
                      - ACCOUNT_CONNECTED
                      active: true
                      secret: a little secret
                      updatedAt: '2021-04-14T09:30:24Z'
      operationId: get-webhook
      description: View a webhook endpoint.
    delete:
      summary: Delete Webhook
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDeleteResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
      operationId: delete-webhook
      description: Delete a webhook endpoint.
      tags:
      - Webhooks
components:
  parameters:
    id:
      name: id
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 200
      description: ID of the specific object in the collection.
      required: true
    cursor:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: Uses the filter values of the previous page to determine the next set of items.
    size:
      name: size
      in: query
      schema:
        type: integer
        example: 50
        minimum: 1
        maximum: 150
        default: 10
      description: The number of objects you want returned in a collection.
  schemas:
    WebhookPostResponse:
      title: WebhookPostResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Webhook'
    WebhookPostRequest:
      title: WebhookPostRequest
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
          description: Name of the webhook endpoint
          example: Event Notification Postback
        url:
          type: string
          minLength: 1
          maxLength: 500
          description: URL of webhook, must begin with https://
          example: https://webhook.clienturl.xyz
        eventTypes:
          type: array
          items:
            $ref: '#/components/schemas/RefWebhookEventType'
        active:
          type: boolean
          description: Whether to set this webhook active to received events
        includePayload:
          type: boolean
          default: false
          description: Whether to put all datapoints' payload into the events(TASK_FINISHED, ACCOUNT_SNYC_TASK_FINISHED)
        secret:
          type: string
          description: The key that will be used to generate HMAC-SHA512 hex digest value in the Smile-Signature header.
          example: a little secret
          minLength: 1
          maxLength: 64
      required:
      - name
      - url
      - eventTypes
      - active
      - secret
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    RefObjectID:
      type: string
      title: Object ID
      description: Unique ID of this object
      example: 17bbf36498de4d68a0d4f86c7b62f69f
    WebhookGetResponse:
      title: WebhookGetResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Webhook'
    Webhook:
      title: Webhook
      type: object
      description: Receive event notifications via Webhooks.
      x-examples:
        Example:
          id: 17bbf36498de4d68a0d4f86c7b62f69f
          createdAt: '2021-04-14T09:30:24Z'
          name: Event Notification Postback
          url: https://webhook.clienturl.xyz
          eventTypes:
          - USER_CREATED
          active: true
          secret: a little secret
          updatedAt: '2021-04-14T09:30:24Z'
      x-tags:
      - Webhooks
      properties:
        id:
          $ref: '#/components/schemas/RefObjectID'
        createdAt:
          $ref: '#/components/schemas/RefDateTime'
        name:
          type: string
          description: Name of the webhook endpoint
          example: Event Notification Postback
        url:
          type: string
          description: URL of webhook, must begin with https://
          example: https://webhook.clienturl.xyz
        secret:
          type: string
          description: The key that will be used to generate HMAC-SHA512 hex digest value in the Smile-Signature header.
          example: a little secret
        eventTypes:
          type: array
          description: Special events that you want to subscribe to
          items:
            $ref: '#/components/schemas/RefWebhookEventType'
        active:
          type: boolean
          default: true
          description: Set to true or false depending on if you would like to enable this webhook or not
        includePayload:
          type: boolean
          default: false
          description: Whether to put all datapoints' payload into the events(TASK_FINISHED_EVENT, ACCOUNT_SNYC_TASK_FINISHED_EVENT)
        updatedAt:
          $ref: '#/components/schemas/RefDateTime'
      required:
      - id
      - createdAt
      - name
      - url
      - eventTypes
      - active
      - updatedAt
    ObjectMetadataRefCode:
      type: string
      title: ObjectMetadataRefCode
      description: Request status code
      enum:
      - OK
      - CREATED
      - INVALID_CREDENTIALS
      - INVALID_PARAMETERS
      - INVALID_TOKEN
      - UNAUTHORIZED_ACCESS
      - MISSING_RESOURCE
      - REQUEST_LIMIT_EXCEEDED
      - SERVER_ERROR
      - UNSUPPORTED_METHOD
      - SERVER_UNAVAILABLE
      - TIME_LIMIT_EXCEEDED
      example: OK
      x-internal: false
    ObjectMetadataRefMessage:
      type: string
      title: ObjectMetadataRefMessage
      description: Message response to the request
      example: Success
      x-internal: false
    WebhookListResponse:
      title: WebhookListResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          type: object
          properties:
            nextCursor:
              $ref: '#/components/schemas/ObjectNextCursor'
            items:
              type: array
              items:
                $ref: '#/components/schemas/Webhook'
    ObjectMetadataRefRequestID:
      type: string
      title: ObjectMetadataRefRequestID
      description: Unique ID that is added to the body of every response for easy traceability of the request in our logs.
      x-internal: false
      example: 5b79399a-6852-4234-bb0e-ad472648282d
    WebhookDeleteResponse:
      title: WebhookDeleteResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
      x-examples: {}
    RefDateTime:
      type: string
      title: Date and Time string
      format: date-time
      example: '2021-04-14T09:30:24Z'
      description: Date and time
    RefWebhookEventType:
      title: RefWebhookEventType
      description: Event Type which will be sent as a notification via webhook
      type: string
      enum:
      - USER_CREATED
      - ACCOUNT_CREATED
      - ACCOUNT_CONNECTED
      - ACCOUNT_DISCONNECTED
      - ACCOUNT_FAILED
      - TASK_STARTED
      - TASK_FINISHED
      - ACCOUNT_SYNC_TASK_FINISHED
      - ARCHIVE_STARTED
      - ARCHIVE_ANALYZED
      - ARCHIVE_REVOKED
      - ARCHIVE_FAILED
      - INVITE_INVITED
      - INVITE_LINKED
      - IDENTITY_ADDED
      - RATING_ADDED
      - TRANSACTIONS_ADDED
      - DOCUMENTS_ADDED
      - DOCUMENTS_UPDATED
      - EMPLOYMENTS_ADDED
      - EMPLOYMENTS_UPDATED
      - INCOMES_ADDED
      - INCOMES_UPDATED
      - CONTRIBUTIONS_ADDED
      - CONTRIBUTIONS_UPDATED
      - EINCOMES_ADDED
      - EINCOMES_UPDATED
      - LIABILITIES_ADDED
      - LIABILITIES_UPDATED
      - INSIGHT_ADDED
      - LINK_ADDED
      - VERIFICATION_STARTED
      - VERIFICATION_COMPLETED
      - RECORD_CREATED
      - RECORD_COMPLETED
      - USER_SESSION_COMPLETED
      - USER_SESSION_RESET
      - ALL_EVENTS
      example: ACCOUNT_CONNECTED
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-provenance:
  method: searched
  source: https://docs.getsmileapi.com/reference
  harvested: '2026-10-20'
  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://docs.getsmileapi.com/reference/create-alpha-blacklist.md
  - https://docs.getsmileapi.com/reference/create-alpha-footprint.md
  - https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md
  - https://docs.getsmileapi.com/reference/create-alpha-maw.md
  - https://docs.getsmileapi.com/reference/create-alpha-signal.md
  - https://docs.getsmileapi.com/reference/create-and-classify-archive.md
  - https://docs.getsmileapi.com/reference/create-archive.md
  - https://docs.getsmileapi.com/reference/create-beta-maw2.md
  - https://docs.getsmileapi.com/reference/create-beta-maw3.md
  - https://docs.getsmileapi.com/reference/create-beta-signal.md
  - https://docs.getsmileapi.com/reference/create-beta-signal2.md
  - https://docs.getsmileapi.com/reference/create-beta-signal3.md
  - https://docs.getsmileapi.com/reference/create-beta-social-security.md
  - https://docs.getsmileapi.com/reference/create-consent-template.md
  - https://docs.getsmileapi.com/reference/create-invite-template.md
  - https://docs.getsmileapi.com/reference/create-invite.md
  - https://docs.getsmileapi.com/reference/create-token-1.md
  - https://docs.getsmileapi.com/reference/create-user-1.md
  - https://docs.getsmileapi.com/reference/create-verification.md
  - https://docs.getsmileapi.com/reference/create-webhook.md
  - https://docs.getsmileapi.com/reference/delete-account.md
  - https://docs.getsmileapi.com/reference/delete-archive.md
  - https://docs.getsmileapi.com/reference/delete-consent-template.md
  - https://docs.getsmileapi.com/reference/delete-invite-template.md
  - https://docs.getsmileapi.com/reference/delete-webhook.md
  - https://docs.getsmileapi.com/reference/disable-account-monitor.md
  - https://docs.getsmileapi.com/reference/generate-account-export.md
  - https://docs.getsmileapi.com/reference/get-account-1.md
  - https://docs.getsmileapi.com/reference/get-account-payload.md
  - https://docs.getsmileapi.com/reference/get-alpha-blacklist.md
  - https://docs.getsmileapi.com/reference/get-alpha-footprint.md
  - https://docs.getsmileapi.com/reference/get-alpha-form.md
  - https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md
  - https://docs.getsmileapi.com/reference/get-alpha-maw.md
  - https://docs.getsmileapi.com/reference/get-alpha-signal.md
  - https://docs.getsmileapi.com/reference/get-archive.md
  - https://docs.getsmileapi.com/reference/get-beta-maw.md
  - https://docs.getsmileapi.com/reference/get-beta-signal.md
  - https://docs.getsmileapi.com/reference/get-beta-social-security.md
  - https://docs.getsmileapi.com/reference/get-contribution.md
  - https://docs.getsmileapi.com/reference/get-document-1.md
  - https://docs.getsmileapi.com/reference/get-eincomes.md
  - https://docs.getsmileapi.com/reference/get-employment-1.md
  - https://docs.getsmileapi.com/reference/get-feature-insight.md
  - https://docs.getsmileapi.com/reference/get-identity-1.md
  - https://docs.getsmileapi.com/reference/get-income-1.md
  - https://docs.getsmileapi.com/reference/get-invite-template.md
  - https://docs.getsmileapi.com/reference/get-invite.md
  - https://docs.getsmileapi.com/reference/get-liabilities.md
  - https://docs.getsmileapi.com/reference/get-link.md
  - https://docs.getsmileapi.com/reference/get-provider-1.md
  - https://docs.getsmileapi.com/reference/get-rating-1.md
  - https://docs.getsmileapi.com/reference/get-task.md
  - https://docs.getsmileapi.com/reference/get-transaction-1.md
  - https://docs.getsmileapi.com/reference/get-user-1.md
  - https://docs.getsmileapi.com/reference/get-user-session-payload.md
  - https://docs.getsmileapi.com/reference/get-verification.md
  - https://docs.getsmileapi.com/reference/get-webhook.md
  - https://docs.getsmileapi.com/reference/list-accounts-1.md
  - https://docs.getsmileapi.com/reference/list-alpha-blacklists.md
  - https://docs.getsmileapi.com/reference/list-alpha-footprints.md
  - https://docs.getsmileapi.com/reference/list-alpha-forms.md
  - https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md
  - https://docs.getsmileapi.com/reference/list-alpha-maws.md
  - https://docs.getsmileapi.com/reference/list-alpha-signals.md
  - https://docs.getsmileapi.com/reference/list-archives.md
  - https://docs.getsmileapi.com/reference/list-beta-maws.md
  - https://docs.getsmileapi.com/reference/list-beta-signals.md
  - https://docs.getsmileapi.com/reference/list-beta-social-securities.md
  - https://docs.getsmileapi.com/reference/list-consent-templates.md
  - https://docs.getsmileapi.com/reference/list-contributions.md
  - https://docs.getsmileapi.com/reference/list-documents-1.md
  - https://docs.getsmileapi.com/reference/list-eincomes.md
  - https://docs.getsmileapi.com/reference/list-employments-1.md
  - https://docs.getsmileapi.com/reference/list-file-types.md
  - https://docs.getsmileapi.com/reference/list-identities-1.md
  - https://docs.getsmileapi.com/reference/list-incomes-1.md
  - https://docs.getsmileapi.com/reference/list-insights.md
  - https://docs.getsmileapi.com/reference/list-invite-log.md
  - https://docs.getsmileapi.com/reference/list-invite-templates.md
  - https://docs.getsmileapi.com/reference/list-invites.md
  - https://docs.getsmileapi.com/reference/list-liabilities.md
  - https://docs.getsmileapi.com/reference/list-links.md
  - https://docs.getsmileapi.com/reference/list-providers.md
  - https://docs.getsmileapi.com/reference/list-ratings-1.md
  - https://docs.getsmileapi.com/reference/list-tasks.md
  - https://docs.getsmileapi.com/reference/list-transactions-1.md
  - https://docs.getsmileapi.com/reference/list-users-1.md
  - https://docs.getsmileapi.com/reference/list-verifications.md
  - https://docs.getsmileapi.com/reference/list-webhooks.md
  - https://docs.getsmileapi.com/reference/reset-user-session.md
  - https://docs.getsmileapi.com/reference/update-invite-template.md
  merge:
    pages: 92
    deduped: 1153
    conflicts_kept_first: 0