beehiiv Webhooks API

openapi: 3.2.0
info:
  title: Beehiiv Webhooks API
  version: 1.0.0
  description: 'Operations tagged Webhooks across 3 of this provider''s published API definitions: beehiiv-openapi.yml, beehiiv-webhook-events-openapi.yml, beehiiv-webhooks-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.beehiiv.com/v2
  description: Default
tags:
- name: Webhooks
paths:
  /publications/{publicationId}/webhooks:
    post:
      operationId: create
      summary: 'Create a webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:write</Badge>'
      description: Create a new webhook for a given publication.
      tags:
      - Webhooks
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Webhook created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_webhooks_WebhookResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: The webhook URL to send events to.
                event_types:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_webhooks_WebhookEventType'
                  description: The types of events the webhook will receive.
                description:
                  type: string
                  description: A description of the webhook.
              required:
              - url
              - event_types
    get:
      operationId: index
      summary: 'List webhooks <Badge intent="info" minimal outlined>OAuth Scope: webhooks:read</Badge>'
      description: Retrieve all webhooks belonging to a specific publication.
      tags:
      - Webhooks
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: limit
        in: query
        description: A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_webhooks_IndexWebhooksResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
    servers:
    - url: https://api.beehiiv.com/v2
      description: Default
  /publications/{publicationId}/webhooks/{endpointId}:
    get:
      operationId: show
      summary: 'Get webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:read</Badge>'
      description: Retrieve a specific webhook belonging to a publication.
      tags:
      - Webhooks
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: endpointId
        in: path
        description: The prefixed ID of the webhook object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_EndpointId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_webhooks_WebhookResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
    patch:
      operationId: update
      summary: 'Update webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:write</Badge>'
      description: Update a webhook subscription for a publication.
      tags:
      - Webhooks
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: endpointId
        in: path
        description: The prefixed ID of the webhook object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_EndpointId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_webhooks_WebhookResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event_types:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_webhooks_WebhookEventType'
                  description: The types of events the webhook will receive.
                description:
                  type: string
                  description: A description of the webhook.
    delete:
      operationId: delete
      summary: 'Delete a webhook <Badge intent="info" minimal outlined>OAuth Scope: webhooks:write</Badge>'
      description: Delete a webhook subscription from a publication.
      tags:
      - Webhooks
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: endpointId
        in: path
        description: The prefixed ID of the webhook object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_EndpointId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_webhooks_WebhooksDeleteResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
    servers:
    - url: https://api.beehiiv.com/v2
      description: Default
webhooks:
  subscribed:
    post:
      operationId: subscribed
      summary: Newsletter List Subscription Subscribed
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_newsletter_list_subscription_NewsletterListSubscription'
      tags:
      - Webhooks
  unsubscribed:
    post:
      operationId: unsubscribed
      summary: Newsletter List Subscription Unsubscribed
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_newsletter_list_subscription_NewsletterListSubscription'
      tags:
      - Webhooks
  paused:
    post:
      operationId: paused
      summary: Subscription Paused
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  resumed:
    post:
      operationId: resumed
      summary: Subscription Resumed
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  episode-published:
    post:
      operationId: episode-published
      summary: Podcast Episode Published
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_podcasts_PodcastEpisode'
      tags:
      - Webhooks
  episode-updated:
    post:
      operationId: episode-updated
      summary: Podcast Episode Updated
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_podcasts_PodcastEpisode'
      tags:
      - Webhooks
  episode-archived:
    post:
      operationId: episode-archived
      summary: Podcast Episode Archived
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_podcasts_PodcastEpisode'
      tags:
      - Webhooks
  episode-deleted:
    post:
      operationId: episode-deleted
      summary: Podcast Episode Deleted
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_podcasts_PodcastEpisode'
      tags:
      - Webhooks
  private-feed-activated:
    post:
      operationId: private-feed-activated
      summary: Podcast Private Feed Activated
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_podcasts_PodcastPrivateFeed'
      tags:
      - Webhooks
  sent:
    post:
      operationId: sent
      summary: Post Sent
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_post_Post'
      tags:
      - Webhooks
  updated:
    post:
      operationId: updated
      summary: Post Updated
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_post_Post'
      tags:
      - Webhooks
  scheduled:
    post:
      operationId: scheduled
      summary: Post Scheduled
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_post_Post'
      tags:
      - Webhooks
  created:
    post:
      operationId: created
      summary: Subscription Created
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  confirmed:
    post:
      operationId: confirmed
      summary: Subscription Confirmed
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  deleted:
    post:
      operationId: deleted
      summary: Subscription Deleted
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  upgraded:
    post:
      operationId: upgraded
      summary: Subscription Upgraded
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  downgraded:
    post:
      operationId: downgraded
      summary: Subscription Downgraded
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  tier-paused:
    post:
      operationId: tier-paused
      summary: Subscription Tier Paused
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  tier-resumed:
    post:
      operationId: tier-resumed
      summary: Subscription Tier Resumed
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  tier-added:
    post:
      operationId: tier-added
      summary: Subscription Tier Created
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  tier-deleted:
    post:
      operationId: tier-deleted
      summary: Subscription Tier Deleted
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_subscription_Subscription'
      tags:
      - Webhooks
  submitted:
    post:
      operationId: submitted
      summary: Survey Response Submitted
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_survey_SurveyResponse'
      tags:
      - Webhooks
components:
  schemas:
    type_webhooks_WebhooksDeleteResponse:
      type: object
      properties:
        message:
          type: string
      title: WebhooksDeleteResponse
    type_ids_EndpointId:
      type: string
      description: The prefixed ID of the endpoint.
      title: EndpointId
    type_webhooks_WebhookEventType:
      type: string
      enum:
      - post.sent
      - post.updated
      - subscription.confirmed
      - subscription.created
      - subscription.downgraded
      - subscription.paused
      - subscription.resumed
      - subscription.tier.paused
      - subscription.tier.resumed
      - subscription.upgraded
      - subscription.tier.created
      - subscription.tier.deleted
      - subscription.deleted
      - newsletter_list_subscription.subscribed
      - newsletter_list_subscription.unsubscribed
      - newsletter_list_subscription.paused
      - newsletter_list_subscription.resumed
      - post.scheduled
      - survey.response_submitted
      - podcasts.episode.published
      - podcasts.episode.updated
      - podcasts.episode.archived
      - podcasts.episode.deleted
      - podcasts.private_feed.activated
      title: WebhookEventType
    type_webhooks_WebhookResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_webhooks_Webhook'
      required:
      - data
      title: WebhookResponse
    type_ids_PublicationId:
      type: string
      description: The prefixed ID of the publication.
      title: PublicationId
    type__Error:
      type: object
      properties:
        status:
          type: integer
        statusText:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type__ErrorDetail'
      required:
      - status
      - statusText
      - errors
      description: The top level error response.
      title: Error
    type_webhooks_Webhook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_ids_EndpointId'
          description: The prefixed ID for the webhook.
        url:
          type: string
          format: uri
          description: The webhook URL to send events to.
        created:
          type: integer
          description: The date the webhook was created. Measured in seconds since the Unix epoch.
        updated:
          type: integer
          description: The date the webhook was last updated. Measured in seconds since the Unix epoch.
        event_types:
          type: array
          items:
            $ref: '#/components/schemas/type_webhooks_WebhookEventType'
          description: The types of events the webhook will receive.
        description:
          type: string
          description: The user-defined description for the webhook.
      required:
      - id
      - url
      - created
      - updated
      - event_types
      - description
      title: Webhook
    type__ErrorDetail:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      title: ErrorDetail
    type_webhooks_IndexWebhooksResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_webhooks_Webhook'
      required:
      - data
      title: IndexWebhooksResponse
    type_subscription_SubscriptionData:
      type: object
      properties:
        created:
          type: integer
          description: The time the subscription was created. Measured in seconds since the Unix epoch.
        email:
          type: string
          description: The email address of the subscription.
        id:
          type: string
          description: The prefixed ID of the subscription.
        referral_code:
          type: string
          description: The code associated to this subscriber to refer others. When a new subscription is created with this referral code, credit for the referral goes to this subscription.
        referring_site:
          type: string
          description: The website that the subscriber was referred from.
        status:
          $ref: '#/components/schemas/type_subscription_SubscriptionDataStatus'
          description: The status of the subscription.
        subscription_tier:
          type: string
          description: The tier of the subscription.
        subscription_premium_tier_names:
          type: array
          items:
            type: string
          description: The names of the premium tiers associated with the subscription.
        stripe_customer_id:
          type: string
          description: The Stripe customer ID associated with the subscription.
        utm_campaign:
          type: string
          description: The acquisition campaign that the subscriber was acquired from.
        utm_channel:
          type: string
          description: The channel that the subscriber was acquired from.
        utm_medium:
          type: string
          description: The medium that the subscriber was acquired from.
        utm_source:
          type: string
          description: The source that the subscriber was acquired from.
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/type_subscription_CustomFieldValue'
          description: An array of custom field values that have been set on the subscription. Each custom field value includes the field name, kind (type), and formatted value.
        tags:
          type: array
          items:
            type: string
          description: An array of tag names that have been applied to the subscription.
      title: SubscriptionData
    type_newsletter_list_subscription_NewsletterListSubscriptionStatus:
      type: string
      enum:
      - pending
      - active
      - inactive
      - paused
      description: The status of the newsletter list subscription.
      title: NewsletterListSubscriptionStatus
    type_subscription_Subscription:
      type: object
      properties:
        uid:
          type: string
          description: The prefixed event ID, unique to each webhook event.
        event_timestamp:
          type: integer
          description: The date the event was created. Measured in seconds since the Unix epoch.
        event_type:
          type: string
          description: The event type.
        data:
          $ref: '#/components/schemas/type_subscription_SubscriptionData'
      title: Subscription
    type_subscription_SubscriptionDataStatus:
      type: string
      enum:
      - validating
      - invalid
      - pending
      - active
      - inactive
      - needs_attention
      description: The status of the subscription.
      title: SubscriptionDataStatus
    type_podcasts_PodcastShowType:
      type: string
      enum:
      - episodic
      - serial
      description: The type of the podcast.<br>`episodic` - Episodes can be consumed in any order.<br>`serial` - Episodes are intended to be consumed in order.
      title: PodcastShowType
    type_survey_SurveyResponse:
      type: object
      properties:
        uid:
          type: string
          description: The prefixed event ID, unique to each webhook event.
        event_timestamp:
          type: integer
          description: The date the event was created. Measured in seconds since the Unix epoch.
        event_type:
          type: string
          description: The event type.
        data:
          $ref: '#/components/schemas/type_survey_SurveyResponseData'
      title: SurveyResponse
    type_newsletter_list_subscription_NewsletterListSubscriptionData:
      type: object
      properties:
        id:
          type: string
          description: The prefixed ID of the newsletter list subscription.
        list_name:
          type: string
          description: The name of the newsletter list.
        subscription_id:
          type: string
          description: The prefixed ID of the subscription.
        email:
          type: string
          description: The email address of the subscriber.
        status:
          $ref: '#/components/schemas/type_newsletter_list_subscription_NewsletterListSubscriptionStatus'
          description: The status of the newsletter list subscription.
        subscribed_at:
          type: integer
          description: The time the subscriber was added to the list. Measured in seconds since the Unix epoch.
        unsubscribed_at:
          type: integer
          description: The time the subscriber was removed from the list. Measured in seconds since the Unix epoch.
        created:
          type: integer
          description: The time the newsletter list subscription was created. Measured in seconds since the Unix epoch.
        updated:
          type: integer
          description: The time the newsletter list subscription was last updated. Measured in seconds since the Unix epoch.
      required:
      - id
      - list_name
      - subscription_id
      - email
      - status
      - created
      - updated
      title: NewsletterListSubscriptionData
    type_post_PostData:
      type: object
      properties:
        audience:
          type: string
          description: The audience that the post is available to on the web. Only applicable if the platform is `web` or `both`.
        authors:
          type: array
          items:
            type: string
          description: An array of author names
        content_tags:
          type: array
          items:
            type: string
          description: All content tags that were associated with the post.
        created:
          type: integer
          description: The time the post was created. Measured in seconds since the Unix epoch
        displayed_date:
          type: integer
          description: The time displayed in place of the `publish_date`. Measured in seconds since the Unix epoch
        id:
          type: string
          description: The prefixed post id
        preview_text:
          type: string
          description: The email preview text
        publish_date:
          type: integer
          description: The time the post was set to be published. Measured in seconds since the Unix epoch
        slug:
          type: string
          description: The web slug where this post can be accessed.
        split_tested:
          type: boolean
          description: A flag to indicate if a split test was done. Only applicable to email posts.
        status:
          $ref: '#/components/schemas/type_post_PostStatus'
          description: The status of the post.<br>`draft` - not been scheduled.<br>`confirmed` - The post will be active after the `scheduled_at`.<br>`archived` - The post is no longer active.
        subject_line:
          type: string
          description: The email subject line. In cases of A/B Testing, this will be adjusted to the winning subject line.
        subtitle:
          type: string
          description: The subtitle displayed in web views
        thumbnail_url:
          type: string
          description: The URL of the thumbnail. Defaults to the Publication logo if not set.
        title:
          type: string
          description: The title displayed in web views
        web_url:
          type: string
          description: The full URL where this post can be accessed on the web. Only applicable if the platform is `web` or `both`.
        platform:
          type: string
          description: The platform that the post is or will be published to.
        meta_default_description:
          type: string
          description: Meta tag description for the post, called SEO Description in the admin UI
        meta_default_title:
          type: string
          description: Meta tag title for the post, called SEO Title in the admin UI
        hidden_from_feed:
          type: boolean
          description: A flag to indicate if the post is hidden from the website feed.
        enforce_gated_content:
          type: boolean
          description: A flag to indicate if the post enforces gated content for non-subscribers.
        email_capture_popup:
          type: boolean
          description: A flag to indicate if popup email capture is enabled for this post.
      required:
      - audience
      - authors
      - content_tags
      - created
      - id
      - preview_text
      - slug
      - split_tested
      - status
      - subject_line
      - subtitle
      - thumbnail_url
      - title
      - platform
      - hidden_from_feed
      - enforce_gated_content
      - email_capture_p

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/beehiiv/refs/heads/main/openapi/beehiiv-webhooks-api-openapi.yml