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

# Get hook credentials

> Returns the legacy hook credential pair (`appkey` and `token`) for the authenticated user, if one exists. Auto-minting of hook credentials has been removed. This endpoint only returns an existing credential — it will not create one. Create API keys in **Settings → API** instead.

Get the existing legacy hook credential pair

**Permission:** requires `hooks`.

**Not callable with an API key.** Requires `hooks`, which ConveYour never grants to service accounts (`deny_for_types: [service]`), so every API key gets `403`. Only a signed-in user with this permission can call it.



## OpenAPI

````yaml /api-reference/specs/webhooks.json get /api/hooks/credentials
openapi: 3.1.0
info:
  title: ConveYour API — Webhooks
  description: List outbound webhook subscriptions and manage legacy webhook credentials.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Webhooks
    description: List outbound webhook subscriptions and manage legacy webhook credentials.
paths:
  /api/hooks/credentials:
    get:
      tags:
        - Webhooks
      summary: Get hook credentials
      description: >-
        Returns the legacy hook credential pair (`appkey` and `token`) for the
        authenticated user, if one exists. Auto-minting of hook credentials has
        been removed. This endpoint only returns an existing credential — it
        will not create one. Create API keys in **Settings → API** instead.


        Get the existing legacy hook credential pair


        **Permission:** requires `hooks`.


        **Not callable with an API key.** Requires `hooks`, which ConveYour
        never grants to service accounts (`deny_for_types: [service]`), so every
        API key gets `403`. Only a signed-in user with this permission can call
        it.
      operationId: getTheExistingLegacyHookCredentialPair
      parameters:
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/HookCredentials'
              example:
                status: ok
                message: success
                data:
                  appkey: hook
                  token: 64a1b2c3d4e5f6a7b8c9d0e1
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    HookCredentials:
      type: object
      description: >-
        The app key and token used to authenticate inbound hook calls. Treat
        both values as secrets.
      properties:
        appkey:
          type: string
          description: The 'hook' application's app key.
        token:
          type: string
          description: The user's hook auth token.
      required:
        - appkey
        - token
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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