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

# Trigger a webhook workflow

> The gthook_ secret in the URL authenticates this request. Do not also send a GreenTick API key. The workflow must be active and use the Webhook event trigger.



## OpenAPI

````yaml /openapi.json post /hooks/{secret}
openapi: 3.1.0
info:
  title: GreenTick Developer API
  version: 1.0.0
  summary: WhatsApp messaging, contacts, workflows, and webhooks
  description: >-
    Use GreenTick's REST API to send WhatsApp messages, synchronize contacts,
    trigger workflows, and receive signed event webhooks. Each API key belongs
    to one connected phone number.
  contact:
    name: GreenTick Support
    url: https://greentick.ai
servers:
  - url: https://api.greentick.ai/v1
    description: GreenTick API v1
security: []
tags:
  - name: System
    description: Health and API metadata
  - name: Messages
    description: Send WhatsApp messages
  - name: Conversations
    description: List inbox threads and fetch message history
  - name: Templates
    description: Discover approved templates and their variables
  - name: Contacts
    description: Synchronize customer contacts
  - name: Labels
    description: Contact label catalog for the connected phone number
  - name: Attributes
    description: Contact custom attribute definitions for the connected phone number
  - name: Phone numbers
    description: WhatsApp sending line for this phone number
  - name: Automations
    description: List enrollable automations and start one for a contact
  - name: Workflow hooks
    description: Trigger GreenTick automations from external systems
  - name: Webhooks
    description: Subscribe Zapier, Make.com, or your own server to GreenTick events
  - name: API key
    description: Check the Bearer API key and account timezone
  - name: MCP platform
    description: Limits, usage, and shared connector behavior
  - name: Media
    description: Host customer-supplied files
  - name: Workflows
    description: Create, publish, and export automations
  - name: Flows
    description: WhatsApp Flows
  - name: AI bots
    description: AI bots and knowledge
  - name: Broadcasts
    description: Template broadcasts
  - name: Catalogs
    description: Commerce catalogs, products, and orders
  - name: Ads
    description: Click-to-WhatsApp ads and conversions
paths:
  /hooks/{secret}:
    post:
      tags:
        - Workflow hooks
      summary: Trigger a webhook workflow
      description: >-
        The gthook_ secret in the URL authenticates this request. Do not also
        send a GreenTick API key. The workflow must be active and use the
        Webhook event trigger.
      operationId: triggerWorkflowHook
      parameters:
        - name: secret
          in: path
          required: true
          schema:
            type: string
            pattern: ^gthook_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowHookRequest'
      responses:
        '202':
          description: Workflow execution started
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      workflowId:
                        type: string
                      executionId:
                        type: string
                      sentCustomerMessage:
                        type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          description: Unknown or inactive hook
      security: []
components:
  schemas:
    WorkflowHookRequest:
      type: object
      required:
        - contact
      properties:
        contact:
          type: object
          required:
            - phone
          properties:
            phone:
              type: string
              example: '919876543210'
        event:
          type: string
          example: order.shipped
        data:
          type: object
          additionalProperties: true
          example:
            order_id: ord_123
            tracking_url: https://example.com/track/ord_123
        metaPhoneNumberId:
          type: string
          description: >-
            Optional Meta phone-number ID when the workflow is not pinned to a
            line.
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - code
              - message
            properties:
              success:
                type: boolean
                example: false
              code:
                type: string
                example: INVALID_TO
              message:
                type: string
                example: to (E.164 phone) is required

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.