---
title: "CreateSCMWebhookEvent"
method: POST
path: "/v1/scm-webhook-events"
tags: ["SCMWebhookEventService"]
---

# CreateSCMWebhookEvent

`POST /v1/scm-webhook-events`

## Request

- Base URL: `https://api.endorlabs.com`
- URL: `https://api.endorlabs.com/v1/scm-webhook-events`
- Auth: none declared

Creates a SCM webhook event.

## Request body

- V1SCMWebhookEvent: SCMWebhookEvent represents SCM webhook events that are processed by the system.
  - `meta` V1Meta, required: Common fields for all Endor Labs resources.
    - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
    - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
    - `description` string: Resource description. Must be less than 1024 bytes.
    - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object.
      - `data` string[]
      - `search_score` number, float: search_score is the score of the resource for search. Internal use only.
      - `tenant` string
      - `will_be_deleted_at` string, date-time: Time that the resource will be deleted.
    - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
    - `name` string, required: Resource name. Must be 63 characters or less.
    - `parent_kind` string: Parent object resource kind, for example, Project.
    - `parent_uuid` string: Parent object UUID.
    - `references` object: Map of objects referenced in a query API.
    - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
    - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
    - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `version` string: Message version.
  - `spec` V1SCMWebhookEventSpec, required
    - `azure_event` V1AzureEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_PULL_REQUEST', required
    - `bitbucket_event` V1BitbucketEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_PULL_REQUEST', required
    - `github_event` V1GitHubEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_INSTALLATION' | 'EVENT_TYPE_PULL_REQUEST' | 'EVENT_TYPE_CHECK_SUITE' | 'EVENT_TYPE_CHECK_RUN' | 'EVENT_TYPE_REPOSITORY' | 'EVENT_TYPE_ISSUE_COMMENT', required
    - `gitlab_event` V1GitLabEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_MERGE_REQUEST', required
    - `payload` string, byte, required: Payload of the event.
    - `platform_source` 'PLATFORM_SOURCE_UNSPECIFIED' | 'PLATFORM_SOURCE_GITHUB' | 'PLATFORM_SOURCE_GITLAB' | 'PLATFORM_SOURCE_GITSERVER' | 'PLATFORM_SOURCE_BITBUCKET' | 'PLATFORM_SOURCE_BINARY' | 'PLATFORM_SOURCE_HUGGING_FACE' | 'PLATFORM_SOURCE_AZURE' | 'PLATFORM_SOURCE_ARCHIVE' | 'PLATFORM_SOURCE_EXTERNAL_AI_SERVICE' | 'PLATFORM_SOURCE_GITHUB_ENTERPRISE', required: Type of source control platform a resource was discovered on.
  - `uuid` string

## Response `200`

A successful response.

- V1SCMWebhookEvent: SCMWebhookEvent represents SCM webhook events that are processed by the system.
  - `meta` V1Meta, required: Common fields for all Endor Labs resources.
    - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
    - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
    - `description` string: Resource description. Must be less than 1024 bytes.
    - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object.
      - `data` string[]
      - `search_score` number, float: search_score is the score of the resource for search. Internal use only.
      - `tenant` string
      - `will_be_deleted_at` string, date-time: Time that the resource will be deleted.
    - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
    - `name` string, required: Resource name. Must be 63 characters or less.
    - `parent_kind` string: Parent object resource kind, for example, Project.
    - `parent_uuid` string: Parent object UUID.
    - `references` object: Map of objects referenced in a query API.
    - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
    - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
    - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `version` string: Message version.
  - `spec` V1SCMWebhookEventSpec, required
    - `azure_event` V1AzureEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_PULL_REQUEST', required
    - `bitbucket_event` V1BitbucketEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_PULL_REQUEST', required
    - `github_event` V1GitHubEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_INSTALLATION' | 'EVENT_TYPE_PULL_REQUEST' | 'EVENT_TYPE_CHECK_SUITE' | 'EVENT_TYPE_CHECK_RUN' | 'EVENT_TYPE_REPOSITORY' | 'EVENT_TYPE_ISSUE_COMMENT', required
    - `gitlab_event` V1GitLabEvent
      - `event_type` 'EVENT_TYPE_UNSPECIFIED' | 'EVENT_TYPE_MERGE_REQUEST', required
    - `payload` string, byte, required: Payload of the event.
    - `platform_source` 'PLATFORM_SOURCE_UNSPECIFIED' | 'PLATFORM_SOURCE_GITHUB' | 'PLATFORM_SOURCE_GITLAB' | 'PLATFORM_SOURCE_GITSERVER' | 'PLATFORM_SOURCE_BITBUCKET' | 'PLATFORM_SOURCE_BINARY' | 'PLATFORM_SOURCE_HUGGING_FACE' | 'PLATFORM_SOURCE_AZURE' | 'PLATFORM_SOURCE_ARCHIVE' | 'PLATFORM_SOURCE_EXTERNAL_AI_SERVICE' | 'PLATFORM_SOURCE_GITHUB_ENTERPRISE', required: Type of source control platform a resource was discovered on.
  - `uuid` string

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-11-03** `4acd9fe15140`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/changes/v1/scm-webhook-events/post.md)

---

[API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/9c1a64674369?raw)