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

# Add a webhook

> Paid plans. From now on, changes that match the filters are POSTed to the URL in signed batches (Standard Webhooks headers), billed like GET /v1/changes. A failed send is tried again later; after 8 failures in a row the webhook is turned off.



## OpenAPI

````yaml /openapi.json post /v1/webhooks
openapi: 3.1.0
info:
  title: LetsFindWork API
  version: '1'
servers:
  - url: https://api.letsfind.work
security:
  - bearer: []
paths:
  /v1/webhooks:
    post:
      summary: Add a webhook
      description: >-
        Paid plans. From now on, changes that match the filters are POSTed to
        the URL in signed batches (Standard Webhooks headers), billed like GET
        /v1/changes. A failed send is tried again later; after 8 failures in a
        row the webhook is turned off.
      operationId: post_CreateWebhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  maxLength: 2000
                  format: uri
                  description: >-
                    Your HTTPS endpoint. It must answer 2xx within 10 seconds;
                    redirects are not followed.
                filters:
                  type: object
                  properties:
                    q:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Words to find in the title, company or department: any
                        part of a word, any case. Every word must match.
                    excludeQ:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Words to find in the title, company or department: any
                        part of a word, any case. Every word must match.
                    title:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Words to find in the title: any part of a word, any
                        case. Every word must match.
                    excludeTitle:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Words to find in the title: any part of a word, any
                        case. Every word must match.
                    department:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Words to find in the department: any part of a word, any
                        case. Every word must match.
                    excludeDepartment:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Words to find in the department: any part of a word, any
                        case. Every word must match.
                    text:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Whole words to find in the job text, any case, any
                        language. Every word must match.
                    excludeText:
                      type: string
                      minLength: 1
                      maxLength: 200
                      description: >-
                        Whole words to find in the job text, any case, any
                        language. Every word must match.
                    company:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Company name, any case. Repeat the param to match any of
                        several values; GET /v1/facets lists the values in use.
                    excludeCompany:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Company name, any case. Repeat the param to match any of
                        several values; GET /v1/facets lists the values in use.
                    agency:
                      type: boolean
                      description: >-
                        true: only jobs of staffing and recruiting firms; false:
                        none of them. Firms are known by name (a list of large
                        firms and the words such firms put in their names).
                    ats:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Applicant tracking system, any case. Repeat the param to
                        match any of several values; GET /v1/facets lists the
                        values in use.
                    excludeAts:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Applicant tracking system, any case. Repeat the param to
                        match any of several values; GET /v1/facets lists the
                        values in use.
                    workplaceType:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Workplace type, any case. Repeat the param to match any
                        of several values; GET /v1/facets lists the values in
                        use.
                    employmentType:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Employment type, any case. Repeat the param to match any
                        of several values; GET /v1/facets lists the values in
                        use.
                    language:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Language of the job text (ISO 639-1), any case. Repeat
                        the param to match any of several values; GET /v1/facets
                        lists the values in use.
                    location:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 20
                      description: >-
                        A place in any common form: a city ("Munich", "München,
                        DE"), a region in any language or its ISO 3166-2 code
                        ("Bavaria", "Bayern", "DE-BY"), a country or its code
                        ("Germany", "DE"), a group of countries ("Europe",
                        "EU"). "Remote" or "Remote in Germany" keep remote jobs
                        only. Repeat the param to match any of several places.
                    excludeLocation:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 20
                      description: >-
                        A place in any common form: a city ("Munich", "München,
                        DE"), a region in any language or its ISO 3166-2 code
                        ("Bavaria", "Bayern", "DE-BY"), a country or its code
                        ("Germany", "DE"), a group of countries ("Europe",
                        "EU"). "Remote" or "Remote in Germany" keep remote jobs
                        only. Repeat the param to match any of several places.
                    country:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Country (ISO 3166-1 alpha-2, any case); a job in several
                        places matches any. Repeat the param to match any of
                        several values; GET /v1/facets lists the values in use.
                    region:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Region or state, as GET /v1/facets lists it, or its ISO
                        3166-2 code ("DE-BY"). Repeat the param to match any of
                        several values; GET /v1/facets lists the values in use.
                    city:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        City, as GET /v1/facets lists it. Repeat the param to
                        match any of several values; GET /v1/facets lists the
                        values in use.
                    occupation:
                      type: array
                      items:
                        type: string
                        pattern: ^\d{1,4}$
                      minItems: 1
                      maxItems: 50
                      description: >-
                        ISCO-08 occupation code or group prefix ("25" holds
                        "2512"). Repeat to match any.
                    excludeOccupation:
                      type: array
                      items:
                        type: string
                        pattern: ^\d{1,4}$
                      minItems: 1
                      maxItems: 50
                      description: >-
                        ISCO-08 occupation code or group prefix ("25" holds
                        "2512"). Repeat to match any.
                    salaryMinEur:
                      type:
                        - integer
                        - 'null'
                      minimum: 0
                      maximum: 10000000
                      description: >-
                        Yearly pay at least this, in EUR (the middle of the
                        employer's range, converted at the day's rate). Jobs
                        without pay are left out.
                    industry:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                      minItems: 1
                      maxItems: 50
                      description: >-
                        Industry of the company, as Wikidata names it ("software
                        industry"); jobs of companies with no known industry are
                        left out. Repeat the param to match any of several
                        values; GET /v1/facets lists the values in use.
                    companySize:
                      type: array
                      items:
                        type: string
                        enum:
                          - 1-10
                          - 11-50
                          - 51-200
                          - 201-500
                          - 501-1000
                          - 1001-5000
                          - 5001-10000
                          - 10001+
                      minItems: 1
                      maxItems: 8
                      description: >-
                        Headcount band of the company. Repeat to match any; jobs
                        of companies with no known headcount are left out.
                    canonical:
                      type: boolean
                      description: >-
                        true: one job per duplicate group (the first posted) and
                        every job without duplicates; false: only the other jobs
                        of each group. Without it, all jobs. A group is the same
                        company, title and places on two or more boards, posted
                        within 30 days.
                    postedAfter:
                      anyOf:
                        - type: string
                          format: date-time
                        - type: string
                          format: date
                      description: >-
                        Jobs posted (or first seen, when earlier or undated) at
                        or after this date or time, UTC
                    ids:
                      type: array
                      items:
                        type: integer
                        exclusiveMinimum: 0
                        maximum: 2147483647
                      minItems: 1
                      maxItems: 100
                      description: Job ids. Repeat the param to match any, up to 100.
                    url:
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 2000
                      minItems: 1
                      maxItems: 10
                      description: >-
                        The job's URL on its board or its application form URL,
                        exactly as the job has it. Repeat the param to match
                        any, up to 10.
                    benefit:
                      type: array
                      items:
                        type: string
                        enum:
                          - health
                          - retirement
                          - paid_time_off
                          - wellness
                      minItems: 1
                      maxItems: 4
                      description: >-
                        Benefit the job text offers, read by rules: health,
                        retirement, paid_time_off, wellness. Repeat the param to
                        match any.
                    visaSponsorship:
                      type: boolean
                      description: >-
                        Read by rules from the job text. true: jobs that say
                        they sponsor visas; false: jobs that say they do not, or
                        that need the right to work already. Jobs whose text
                        says nothing are left out.
                  default: {}
                  additionalProperties: false
                  description: Any filters of GET /v1/changes; none sends every change
              required:
                - url
      responses:
        '201':
          description: The webhook, with its signing secret (shown only now)
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  url:
                    type: string
                  filters:
                    type: object
                    additionalProperties: {}
                  failures:
                    type: integer
                    description: Failed sends in a row
                  lastError:
                    type:
                      - string
                      - 'null'
                  disabledAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Turned off after 8 failed sends in a row
                  createdAt:
                    type: string
                    format: date-time
                  secret:
                    type: string
                required:
                  - id
                  - url
                  - filters
                  - failures
                  - lastError
                  - disabledAt
                  - createdAt
                  - secret
        '400':
          description: Not a public HTTPS URL, no paid plan, or too many webhooks
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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