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

# Create Hook URL

> Create the inbound hook URL of a triggered project. Anything that can POST (Zapier or Make with their generic webhook step, n8n, a CRM, your own server) can add one recipient by sending a request to this URL, with no API key. See [Inbound hook](/api-reference/webhooks/inbound-hook) for the request body and answers.

The URL is shown only in this response. Calling this again creates a new URL and the previous one stops working at once, which is how you rotate a URL that leaked. The project must have a trigger set (any source). This call is not replayed by `Idempotency-Key`: the URL it returns is a secret shown once, so a retry mints a new URL.



## OpenAPI

````yaml /api-reference/openapi.json post /projects/{id}/hook
openapi: 3.1.0
info:
  title: Political Comms API
  summary: >-
    Direct-to-carrier political texting API for campaigns, PACs, advocacy
    organizations, fundraisers, and elected officials.
  description: >-
    Public REST API for the Political Comms platform. Surfaces include Projects
    (compose, test, schedule, send, and triggered projects that text each person
    a trigger brings in), Conversations (read inbound threads and reply inside
    them), Lists (one import for phone numbers and emails, and analysis), Media
    Files, Organizations and hierarchy, Brands, Campaigns, Tracking Domains,
    Webhook Endpoints, Phone Numbers, Analytics, and Billing.


    Authentication is an API key passed in the `X-API-Key` header. Keys are
    generated from the dashboard at Admin → API and are prefixed `pc_live_`. All
    POST and PATCH endpoints that mutate state are designed to be safe to retry,
    with optional `Idempotency-Key` headers for stronger guarantees. Rate limit
    is 600 requests per minute per key (bursts up to 600, refilling at 10 per
    second, the same for every scope; the `X-RateLimit-Limit` header reports
    your key's exact limit, and `Retry-After` on a 429 is the seconds until your
    next request is allowed).


    Webhooks emit `message.sent`, `message.delivered`, `message.failed`,
    `message.replied`, and `link.clicked` events, plus email events including
    `email.sent`, `email.failed` and `email.opened`. Payloads are HMAC-signed;
    validate the signature before trusting any payload.


    A Model Context Protocol (MCP) server is available at
    https://docs.politicalcomms.com/mcp for AI agents that need to search the
    documentation programmatically. The developer hub at
    https://politicalcomms.com/developers/ has quickstart examples in cURL, raw
    HTTP, and Python.


    Triggered projects and email campaigns have no contact list: each person is
    added when a trigger fires (a WinRed or Anedot donation, a link click or
    reply in another project or campaign, or an API call or inbound hook URL),
    and gets one message, immediately or after a delay.
  version: 1.14.0
  termsOfService: https://politicalcomms.com/terms/
  contact:
    name: Political Comms Support
    email: support@politicalcomms.com
    url: https://docs.politicalcomms.com
  license:
    name: Proprietary
    url: https://politicalcomms.com/terms/
  x-logo:
    url: https://politicalcomms.com/images/brand/pcomms-logo-left-of-text.png
    altText: Political Comms
    backgroundColor: '#ffffff'
    href: https://politicalcomms.com/
  x-mcp:
    url: https://docs.politicalcomms.com/mcp
    discovery_url: https://docs.politicalcomms.com/.well-known/mcp
    transport: http
    auth: none
    tools:
      - search_political_comms
      - query_docs_filesystem_political_comms
      - submit_feedback
servers:
  - url: https://api.politicalcomms.com/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Projects
    description: Create, edit, test, schedule, and inspect projects.
  - name: Conversations
    description: >-
      Read inbound threads and reply inside them from the same number.
      Conversations are created by project sends; the API never starts one.
  - name: Phone Numbers
    description: List phone numbers across 10DLC campaigns and toll-free verifications.
  - name: Toll-Free Verifications
    description: >-
      List toll-free verifications (carrier registrations) across your
      organization hierarchy.
  - name: Brands
    description: List brands across your organization hierarchy.
  - name: 10DLC Campaigns
    description: >-
      List 10DLC campaigns (carrier registrations) across your organization
      hierarchy.
  - name: Email Campaigns
    description: >-
      Create, schedule, and report on email campaigns. Pause, resume, and test
      sends are deliverability decisions a human makes while watching a send,
      and live in the dashboard.
  - name: Email Templates
    description: Create and read saved email templates.
  - name: Email Senders
    description: >-
      Read the sender identities (From addresses) on your verified domains.
      Identities carry the physical mailing address and paid-for-by disclaimer,
      so they are created and edited in the dashboard.
  - name: Email Suppressions
    description: >-
      Addresses that will not be emailed: unsubscribes, bounces, complaints, and
      addresses you add. Read, add, and lift them in bulk to keep your own
      opt-out record in sync with ours. They apply automatically to every email
      send.
  - name: Contact Lists
    description: >-
      List, import, and analyze lists. One import brings in phone numbers,
      emails, or both, or a do-not-contact file.
  - name: Tags
    description: >-
      Label contacts and send to the label. Manual tags have members you add and
      remove; activity tags (donated, clicked, responded, sent) apply by
      themselves. Send to tags with `tag_ids` on projects and email campaigns.
  - name: Media Files
    description: List, import, and fetch media files.
  - name: Sending Domains
    description: >-
      Read the sending domains in your organization and the DNS records to
      publish. Domains are added in the dashboard: DNS is published by hand, so
      creation is not part of the API.
  - name: Tracking Domains
    description: >-
      List active link-tracking domains. Use the returned ids as
      `link_tracking_domain_id` on project create/update.
  - name: Webhook Endpoints
    description: >-
      Read your webhook endpoints and whether deliveries to them are failing.
      Endpoints are created, edited and re-enabled in the dashboard, where the
      signing secret is shown.
  - name: Organizations
    description: List descendant organizations and hierarchy.
  - name: Billing
    description: Usage and billing data across your organization.
  - name: Analytics
    description: Message statistics and delivery performance.
paths:
  /projects/{id}/hook:
    post:
      tags:
        - Projects
      summary: Create Hook URL
      description: >-
        Create the inbound hook URL of a triggered project. Anything that can
        POST (Zapier or Make with their generic webhook step, n8n, a CRM, your
        own server) can add one recipient by sending a request to this URL, with
        no API key. See [Inbound hook](/api-reference/webhooks/inbound-hook) for
        the request body and answers.


        The URL is shown only in this response. Calling this again creates a new
        URL and the previous one stops working at once, which is how you rotate
        a URL that leaked. The project must have a trigger set (any source).
        This call is not replayed by `Idempotency-Key`: the URL it returns is a
        secret shown once, so a retry mints a new URL.
      operationId: createProjectHook
      parameters:
        - $ref: '#/components/parameters/IdPath'
      responses:
        '201':
          description: Hook URL created.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/TriggerHook'
                additionalProperties: true
              example:
                success: true
                data:
                  hook_url: >-
                    https://api.politicalcomms.com/webhooks/trigger/text/8a3f5c7e-2d91-4b64-ae08-6f1c9d3e7b52/EXAMPLE_SECRET_SHOWN_ONCE
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The project is not triggered. Error code CONFLICT.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    IdPath:
      name: id
      in: path
      required: true
      description: Resource ID
      schema:
        type: string
  schemas:
    TriggerHook:
      type: object
      required:
        - hook_url
      properties:
        hook_url:
          type: string
          format: uri
          description: >-
            The inbound hook URL with the secret in its path, for tools that can
            only be given a URL. It is on the organization's own domain when
            there is one to use (the tracking domain the project or campaign
            uses for its links, else the organization's only tracking domain,
            else its only dashboard domain or its parent's); otherwise on the
            API host. It is shown only in this response and is the whole
            credential, so store it like a secret. Any previous URL or secret
            for this project or campaign stops working at once.
        endpoint_url:
          type: string
          format: uri
          description: >-
            The same hook with no secret in the address, on the same host as
            `hook_url`. Send `secret` in an `X-Hook-Secret` header. Prefer this
            form when the caller can set headers.
        secret:
          type: string
          description: >-
            The hook secret, for the `X-Hook-Secret` header. Shown only in this
            response.
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: >-
            Machine-readable error code, e.g. VALIDATION_ERROR,
            ORG_ACCESS_DENIED, PROJECT_NOT_FOUND.
        correlationId:
          type: string
          description: Request correlation ID; include it in support requests.
        details:
          type:
            - array
            - object
          description: >-
            Present on some errors. For VALIDATION_ERROR, an array of { field,
            message, code } with one entry per rejected field (field is the
            dotted path); an object for other codes (e.g. insufficient-balance
            shortfall).
      required:
        - error
        - code
      additionalProperties: true
      description: >-
        Standard error body produced by the API error handler for 4xx/5xx
        responses.
    AuthErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Short error summary.
        message:
          type: string
          description: Human-readable detail.
      required:
        - error
        - message
      additionalProperties: true
      description: >-
        Error body returned by the API-key authentication layer (401 and
        permission 403s).
    RateLimitErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
        message:
          type: string
        code:
          type: string
          enum:
            - RATE_LIMIT_EXCEEDED
        statusCode:
          type: integer
          enum:
            - 429
        retryAfter:
          type: integer
          description: >-
            Seconds until the rate-limit window resets. Also sent as the
            Retry-After header.
      required:
        - success
        - error
        - code
        - statusCode
        - retryAfter
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: API key required
            message: Please provide an API key in the X-API-Key header
    Forbidden:
      description: >-
        The API key lacks the required permission scope, or the requested
        resource belongs to an organization outside the key's hierarchy.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/AuthErrorResponse'
              - $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingScope:
              summary: >-
                Key lacks the required permission scope (here a GET from a key
                without `public:read`)
              value:
                error: Insufficient permissions
                message: >-
                  This API key does not have the required permissions:
                  public:read
            orgAccessDenied:
              summary: Resource outside the key's organization hierarchy
              value:
                error: >-
                  Access denied: You do not have permission to access this
                  organization's data
                code: ORG_ACCESS_DENIED
                correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e
    NotFound:
      description: Resource not found or not visible to this API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Project not found
            code: PROJECT_NOT_FOUND
            correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e
    RateLimited:
      description: Rate limit exceeded. Check the Retry-After header.
      headers:
        Retry-After:
          description: Seconds until the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
          example:
            success: false
            error: Rate limit exceeded
            message: Maximum 600 requests per 60 seconds
            code: RATE_LIMIT_EXCEEDED
            statusCode: 429
            retryAfter: 3
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: An unexpected error occurred. Please try again later.
            code: INTERNAL_ERROR
            correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Authenticate every request by passing your API key in the X-API-Key
        header. Keys are scoped to your organization hierarchy. A key carries up
        to three permissions: `public:read` for GET requests, `public:write` for
        POST, PATCH, and PUT requests, and `public:delete` for DELETE requests.
        `public:delete` is only available together with `public:write`.

````

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