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

# Register or change the webhook

> One per agency. Replaces the URL and event list. The first call generates a secret and returns it once.



## OpenAPI

````yaml /openapi.json put /webhook
openapi: 3.1.0
info:
  title: Signal Partner API
  description: >-
    Send Signal enquiries, viewings and listings from your system, and receive
    what Signal learns back as signed webhooks. Every call is in beta:
    documented ahead of going live, it answers `501 not_available_yet` until
    then.
  contact:
    name: Signal
    url: https://signalproptech.com/
  version: 1.0.0-beta
servers:
  - url: https://api.signalproptech.com/api/v1/partner
    description: Production
security: []
tags:
  - name: Enquiries
    description: >-
      Hand Signal an enquiry that started in your system, and read where it
      stands.
  - name: Viewings
    description: >-
      Tell Signal about viewings booked in your system, so it can remind and ask
      for feedback.
  - name: Listings and new homes
    description: >-
      Keep Signal's copy of your listings, developments, units and reservations
      up to date.
  - name: Webhooks
    description: >-
      Register where Signal sends events, test it, and catch up on what you
      missed.
  - name: Events
    description: >-
      What Signal sends to your webhook, one page per event type. Check the
      webhook- headers before trusting the body.
paths:
  /webhook:
    put:
      tags:
        - Webhooks
      summary: Register or change the webhook
      description: >-
        One per agency. Replaces the URL and event list. The first call
        generates a secret and returns it once.
      operationId: put_webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookIn'
        required: true
      responses:
        '200':
          description: >-
            The registration. `secret` appears only when we generated or changed
            it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookOut'
        '401':
          description: The key is missing, unknown or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: The body is over 64 KB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: The body is not JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Validation failed. `fields` lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limited. Retry after the number of seconds in `Retry-After`.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '501':
          description: Not live yet (beta).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
        - AgencyKey: []
components:
  schemas:
    WebhookIn:
      properties:
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
          description: >-
            HTTPS on port 443. Put your own agency id in it: we treat it as
            opaque.
        events:
          items:
            type: string
          type: array
          maxItems: 50
          minItems: 1
          title: Events
          description: >-
            Event types to send. ["*"] means all, including future ones, and
            wins over named types. POST /webhook/test always sends webhook.test.
        secret:
          anyOf:
            - type: string
              pattern: ^whsec_[A-Za-z0-9+/]{32,86}={0,2}$
            - type: 'null'
          title: Secret
          description: >-
            Leave out on the first call and we generate one. Send one only to
            rotate: we sign with old and new for 24 hours.
      type: object
      required:
        - url
        - events
      title: WebhookIn
      description: 'The agency''s webhook: where to send events, and which.'
    WebhookOut:
      properties:
        url:
          type: string
          title: Url
          description: Where we send events.
        events:
          items:
            type: string
          type: array
          title: Events
          description: The event types we send.
        status:
          type: string
          enum:
            - active
            - disabled
          title: Status
          description: >-
            active: we deliver to it. disabled: switched off after a 410 or 5
            days of failures; register again to switch it back on.
        disabled_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Disabled Reason
          description: Why it was switched off.
        secret:
          anyOf:
            - type: string
            - type: 'null'
          title: Secret
          description: Returned only when we generated or changed it. Store it.
      type: object
      required:
        - url
        - events
        - status
      title: WebhookOut
      description: The agency's webhook registration.
    ErrorBody:
      properties:
        error:
          type: string
          title: Error
          description: >-
            Stable machine code: validation_failed, unauthorized, bad_request,
            forbidden, not_found, method_not_allowed, conflict, too_large,
            unsupported_media_type, rate_limited, cursor_expired,
            not_available_yet or internal_error. Any other status gives error.
        message:
          type: string
          title: Message
          description: What went wrong, in plain English.
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Quote this to us and we can find the call.
        fields:
          items:
            $ref: '#/components/schemas/FieldError'
          type: array
          title: Fields
          description: Each problem with the request. Empty for other errors.
      type: object
      required:
        - error
        - message
      title: ErrorBody
      description: Every error has this shape.
    FieldError:
      properties:
        path:
          type: string
          title: Path
          description: >-
            Where the problem is, e.g. `contact.phone` or `house_types[0].name`.
            Empty for the request as a whole.
        code:
          type: string
          title: Code
          description: >-
            Stable code: required, empty, too_long, missing_offset, not_allowed,
            invalid_json or invalid.
        message:
          type: string
          title: Message
          description: What is wrong with this field, in plain English.
      type: object
      required:
        - path
        - code
        - message
      title: FieldError
      description: One problem with one field.
  securitySchemes:
    AgencyKey:
      type: http
      description: >-
        The agency's secret key, sent as `Authorization: Bearer <key>`. One key
        per agency.
      scheme: bearer

````

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