> ## Documentation Index
> Fetch the complete documentation index at: https://developer.finogates.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Webhook

> Tell Finogate the single web address where it should send you automatic
updates when things happen on your platform.

When you call this, you:

- Give us one web address (URL) where you want notifications sent
- Choose which events you want to hear about — specific ones, whole groups,
  or all of them

Your platform has exactly one webhook. If you have already set one up,
calling this again simply replaces it — the web address and the chosen
events — with the new details. It does not create a second webhook.

The **first time** you set up your webhook, the response also includes a
**signing secret**: a private key you use to confirm that a notification
really came from Finogate. The signing secret is shown **only once**, right
here in this response — save it somewhere safe, it cannot be shown again.
When you later update an existing webhook, no new secret is issued and the
``secret`` field is empty.



## OpenAPI

````yaml POST /v1/platform/webhooks
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/webhooks:
    post:
      tags:
        - webhooks
      summary: Set Up or Update Your Webhook
      description: >-
        Tell Finogate the single web address where it should send you automatic

        updates when things happen on your platform.


        When you call this, you:


        - Give us one web address (URL) where you want notifications sent

        - Choose which events you want to hear about — specific ones, whole
        groups,
          or all of them

        Your platform has exactly one webhook. If you have already set one up,

        calling this again simply replaces it — the web address and the chosen

        events — with the new details. It does not create a second webhook.


        The **first time** you set up your webhook, the response also includes a

        **signing secret**: a private key you use to confirm that a notification

        really came from Finogate. The signing secret is shown **only once**,
        right

        here in this response — save it somewhere safe, it cannot be shown
        again.

        When you later update an existing webhook, no new secret is issued and
        the

        ``secret`` field is empty.
      operationId: set_webhook_v1_platform_webhooks_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformWebhookCreate'
      responses:
        '200':
          description: >-
            Your webhook after this update. `secret` is present only on first
            setup.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
              example:
                status_code: 200
                data:
                  webhook:
                    id: c4f2e8a1-3b7d-4e9f-a1c2-6d8e3f7a9b0c
                    url: https://example.com/webhooks
                    events:
                      - payment_intent.succeeded
                      - payment_intent.failed
                      - payout.settled
                    is_active: true
                    created_at: '2026-04-01T10:30:00Z'
                  secret: whsec_9f2b7c1a4d6e8091a2b3c4d5e6f70819
                query_generated_time: 1712847600000
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    PlatformWebhookCreate:
      properties:
        url:
          type: string
          maxLength: 2048
          minLength: 1
          title: Url
          description: HTTPS URL that will receive webhook POST requests.
          examples:
            - https://example.com/webhooks
        events:
          items:
            type: string
          type: array
          title: Events
          description: >-
            Individual event types to subscribe to. An empty list subscribes to
            all events.
          examples:
            - - payment_intent.succeeded
              - payment_intent.failed
        event_groups:
          items:
            type: string
          type: array
          title: Event Groups
          description: >-
            Event groups to subscribe to (e.g. 'payment', 'wallet'). Expanded
            into individual event types and merged with events.
          examples:
            - - payment
              - compliance
        description:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Description
          description: Optional human-readable description for the webhook endpoint.
          examples:
            - Production payment notifications
      type: object
      required:
        - url
      title: PlatformWebhookCreate
      description: Create a new webhook endpoint on the platform.
    CommonResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse
      description: |-
        Standard response wrapper for single-object responses and errors.

        Generic over the payload type. A route that declares
        ``CommonResponse[SomeModel]`` gets the real ``data`` schema rendered in
        OpenAPI/Swagger; a bare ``CommonResponse`` leaves ``data`` untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````