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

# Get outgoing webhook

> Returns the details of the specified outgoing webhook.

Requires the following permissions:
- `outbound-webhooks:ReadConfig`



## OpenAPI

````yaml openapi_v5.yaml get /integrations/webhooks/v1/{id}
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/5
  - url: https://api.eu2.coralogix.com/mgmt/openapi/5
  - url: https://api.coralogix.us/mgmt/openapi/5
  - url: https://api.cx498.coralogix.com/mgmt/openapi/5
  - url: https://api.coralogix.in/mgmt/openapi/5
  - url: https://api.coralogixsg.com/mgmt/openapi/5
  - url: https://api.ap3.coralogix.com/mgmt/openapi/5
security:
  - apiKeyAuth: []
tags:
  - name: AI Applications Service
    description: Manage the catalog of AI applications discovered from spans.
    externalDocs:
      url: ''
  - name: AI Evaluations Service
    description: >-
      Manage AI evaluations and the custom evaluation catalog for AI
      applications.
    externalDocs:
      url: ''
  - name: API Keys Admin Service
    description: Administrative operations for API Keys management.
    externalDocs:
      url: ''
  - name: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - name: Actions Service
    description: View and manage your Actions.
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Alert definitions service
    description: >-
      View and manage your alerts using alert definitions - data structures that
      contain the configuration required to create an alert.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Alert events service
    description: >-
      Get information regarding your alert events - instances of alerts being
      triggered.
    externalDocs:
      description: Learn more about alert events and incidents in our documentation.
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Case Events service
    description: Manage case events, comments, and external thread synchronization.
    externalDocs:
      url: ''
  - name: Case Settings service
    description: Manage case settings team configurations.
    externalDocs:
      url: ''
  - name: Cases notification service
    description: Track notification adjacent data for cases.
    externalDocs:
      url: ''
  - name: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, unacknowledge, resolve, and close cases to streamline
      investigations and follow-ups.
    externalDocs:
      description: Learn more about Cases in our documentation
      url: https://coralogix.com/docs/user-guides/cases/
  - name: Connector Schema service
    description: Retrieve connector schemas for notification center integrations
    externalDocs:
      description: Learn more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Connectors service
    description: >-
      View and manage your connectors - integration instances for notification
      destinations
    externalDocs:
      description: Lean more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - name: Data Usage Query service
    description: >-
      Query billable data usage through the public Coralogix API using daily or
      hourly bucketed aggregations over supported labels.
    externalDocs:
      url: ''
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    externalDocs:
      url: ''
  - name: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Entities service
    description: Query information about registered entities in the notification center
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: Events Service
    description: A service for querying events.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    externalDocs:
      url: ''
  - name: Extension deployment service
    description: A service that enables querying for extension deployment information.
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Extension service
    description: A service that enables querying for extension information.
    externalDocs:
      description: Learn more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Folders for views service
    description: Create and manage view folders.
    externalDocs:
      url: ''
  - name: Global routers service
    description: >-
      View and manage your global routers - entities that direct notifications
      to configured destinations based on conditions
    externalDocs:
      description: Lean more about global routers in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/routing/introduction/
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Incidents service
    description: >-
      Handle all operations related to incident management within Coralogix.
      Identify, manage, and resolve incidents efficiently through automated
      workflows and team collaboration.
    externalDocs:
      description: Find out more about incident management in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Integration service
    description: A service that enables querying for integration information.
    externalDocs:
      description: Find out more about integrations in our documentation.
      url: https://coralogix.com/docs/integrations/getting-started/
  - name: Metrics Data Archive Service
    description: View and manage your storage targets for metrics.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Notifications testing service
    description: >-
      Test your notification center configurations including connectors,
      presets, and templates
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: Outgoing webhooks service
    externalDocs:
      description: Find out more about outbound webhooks in our documentation.
      url: >-
        https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Presets service
    description: >-
      View and manage your presets - pre-configured templates for notification
      content rendering
    externalDocs:
      description: Lean more about presets in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/presets/introduction/
  - name: Quota Allocation Rule Set service
    description: Manage quota allocation rules for different entity types.
    externalDocs:
      url: ''
  - name: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Retentions Service
    description: View and manage retentions
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - name: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Target Service
    description: View and manage your storage targets for logs.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Team Groups Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - name: Users Management Service
    description: >-
      Manage team members (users) including creation, updates, search, and
      status management.
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
paths:
  /integrations/webhooks/v1/{id}:
    get:
      tags:
        - Outgoing webhooks service
      summary: Get outgoing webhook
      description: |-
        Returns the details of the specified outgoing webhook.

        Requires the following permissions:
        - `outbound-webhooks:ReadConfig`
      operationId: OutgoingWebhooksService_GetOutgoingWebhook
      parameters:
        - description: The unique identifier of the outgoing webhook.
          in: path
          name: id
          required: true
          schema:
            minLength: 0
            type: string
            description: The unique identifier of the outgoing webhook.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOutgoingWebhookResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      externalDocs:
        url: ''
components:
  schemas:
    GetOutgoingWebhookResponse:
      title: Get outgoing webhook response
      type: object
      properties:
        webhook:
          $ref: '#/components/schemas/OutgoingWebhook'
      description: Response containing the details of an outgoing webhook.
      externalDocs:
        url: ''
    Error:
      type: object
      properties:
        code:
          maximum: 599
          minimum: 100
          type: integer
          description: HTTP status code of the error (for example 400, 404, 500).
          format: int32
        message:
          maxLength: 4096
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description of the error.
      description: Standard error response body returned for a failed request.
    OutgoingWebhook:
      title: Outgoing webhook
      type: object
      oneOf:
        - required:
            - genericWebhook
          type: object
        - required:
            - slack
          type: object
        - required:
            - pagerDuty
          type: object
        - required:
            - sendLog
          type: object
        - required:
            - emailGroup
          type: object
        - required:
            - microsoftTeams
          type: object
        - required:
            - jira
          type: object
        - required:
            - opsgenie
          type: object
        - required:
            - demisto
          type: object
        - required:
            - awsEventBridge
          type: object
        - required:
            - ibmEventNotifications
          type: object
        - required:
            - msTeamsWorkflow
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - genericWebhook
                type: object
              - required:
                  - slack
                type: object
              - required:
                  - pagerDuty
                type: object
              - required:
                  - sendLog
                type: object
              - required:
                  - emailGroup
                type: object
              - required:
                  - microsoftTeams
                type: object
              - required:
                  - jira
                type: object
              - required:
                  - opsgenie
                type: object
              - required:
                  - demisto
                type: object
              - required:
                  - awsEventBridge
                type: object
              - required:
                  - ibmEventNotifications
                type: object
              - required:
                  - msTeamsWorkflow
                type: object
      properties:
        awsEventBridge:
          $ref: '#/components/schemas/AwsEventBridgeConfig'
        createdAt:
          minLength: 0
          type: string
          description: Creation timestamp.
          format: date-time
        demisto:
          $ref: '#/components/schemas/DemistoConfig'
        emailGroup:
          $ref: '#/components/schemas/EmailGroupConfig'
        externalId:
          minimum: 0
          type: integer
          description: External identifier.
          format: int64
          example: 123456
        genericWebhook:
          $ref: '#/components/schemas/GenericWebhookConfig'
        ibmEventNotifications:
          $ref: '#/components/schemas/IbmEventNotificationsConfig'
        id:
          minLength: 0
          type: string
          description: Unique identifier.
          example: webhook_id
        jira:
          $ref: '#/components/schemas/JiraConfig'
        microsoftTeams:
          $ref: '#/components/schemas/MicrosoftTeamsConfig'
        msTeamsWorkflow:
          $ref: '#/components/schemas/MSTeamsWorkflowConfig'
        name:
          minLength: 0
          type: string
          description: Display name.
          example: my_webhook
        opsgenie:
          $ref: '#/components/schemas/OpsgenieConfig'
        pagerDuty:
          $ref: '#/components/schemas/PagerDutyConfig'
        sendLog:
          $ref: '#/components/schemas/SendLogConfig'
        slack:
          $ref: '#/components/schemas/SlackConfig'
        type:
          $ref: '#/components/schemas/WebhookType'
        updatedAt:
          minLength: 0
          type: string
          description: Last-updated timestamp.
          format: date-time
        url:
          minLength: 0
          type: string
          description: URL.
          example: slack.webhook.com
      description: Outgoing webhook.
      externalDocs:
        url: ''
    AwsEventBridgeConfig:
      title: AWS EventBridge configuration
      type: object
      properties:
        detail:
          minLength: 0
          type: string
          description: Detail.
        detailType:
          minLength: 0
          type: string
          description: The detail type.
          example: detail_type
        eventBusArn:
          minLength: 0
          type: string
          description: The event bus arn.
          example: arn:aws:events:us-east-1:123456789012:event-bus/default
        roleName:
          minLength: 0
          type: string
          description: The role name.
          example: role_name
        source:
          minLength: 0
          type: string
          description: Source.
          example: source
      description: Aws event bridge config.
      externalDocs:
        url: ''
    DemistoConfig:
      title: Demisto configuration
      type: object
      properties:
        payload:
          minLength: 0
          type: string
          description: Raw payload data.
        uuid:
          minLength: 0
          type: string
          description: The uuid.
          example: d838cd7b-087b-40c6-bc33-80997020f5d0
      description: Demisto config.
      externalDocs:
        url: ''
    EmailGroupConfig:
      title: Email group configuration
      type: object
      properties:
        emailAddresses:
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            description: The email addresses.
          description: The email addresses.
          example:
            - example@coralogix.com
      description: Email group config.
      externalDocs:
        url: ''
    GenericWebhookConfig:
      title: Generic webhook configuration
      type: object
      properties:
        headers:
          type: object
          additionalProperties:
            minLength: 0
            type: string
          description: The headers.
        method:
          $ref: '#/components/schemas/MethodType'
        payload:
          minLength: 0
          type: string
          description: Raw payload data.
        uuid:
          minLength: 0
          type: string
          description: The uuid.
          example: d838cd7b-087b-40c6-bc33-80997020f5d0
      description: Generic webhook config.
      externalDocs:
        url: ''
    IbmEventNotificationsConfig:
      title: IBM event notification configuration
      type: object
      properties:
        endpointType:
          $ref: '#/components/schemas/EndpointType'
        eventNotificationsInstanceId:
          minLength: 0
          type: string
          description: The event notifications instance id.
        regionId:
          minLength: 0
          type: string
          description: The region id.
        sourceId:
          minLength: 0
          type: string
          description: The source id.
        sourceName:
          minLength: 0
          type: string
          description: The source name.
      description: Ibm event notifications config.
      externalDocs:
        url: ''
    JiraConfig:
      title: Jira configuration
      type: object
      properties:
        apiToken:
          minLength: 0
          type: string
          description: The api token.
          example: jira_api_token
        email:
          minLength: 0
          type: string
          description: Email address.
          example: jira_email
        projectKey:
          minLength: 0
          type: string
          description: The project key.
          example: jira_project_key
      description: Jira config.
      externalDocs:
        url: ''
    MicrosoftTeamsConfig:
      title: Microsoft Teams configuration
      type: object
      additionalProperties: false
      description: Microsoft teams config.
      externalDocs:
        url: ''
    MSTeamsWorkflowConfig:
      title: Microsoft Teams workflow configuration
      type: object
      additionalProperties: false
      description: Ms teams workflow config.
      externalDocs:
        url: ''
    OpsgenieConfig:
      title: Opsgenie configuration
      type: object
      additionalProperties: false
      description: Opsgenie config.
      externalDocs:
        url: ''
    PagerDutyConfig:
      title: PagerDuty configuration
      type: object
      properties:
        serviceKey:
          minLength: 0
          type: string
          description: The service key.
          example: pager_duty_service_key
      description: Pager duty config.
      externalDocs:
        url: ''
    SendLogConfig:
      title: Send log configuration
      type: object
      properties:
        payload:
          minLength: 0
          type: string
          description: Raw payload data.
        uuid:
          minLength: 0
          type: string
          description: The uuid.
          example: d838cd7b-087b-40c6-bc33-80997020f5d0
      description: Send log config.
      externalDocs:
        url: ''
    SlackConfig:
      title: Slack configuration
      type: object
      properties:
        attachments:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/Attachment'
          description: The attachments.
        digests:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/Digest'
          description: The digests.
      description: Slack config.
      externalDocs:
        url: ''
    WebhookType:
      enum:
        - UNKNOWN
        - GENERIC
        - SLACK
        - PAGERDUTY
        - SEND_LOG
        - EMAIL_GROUP
        - MICROSOFT_TEAMS
        - JIRA
        - OPSGENIE
        - DEMISTO
        - AWS_EVENT_BRIDGE
        - IBM_EVENT_NOTIFICATIONS
        - MS_TEAMS_WORKFLOW
      type: string
      description: Webhook type.
    MethodType:
      enum:
        - UNKNOWN
        - GET
        - POST
        - PUT
      type: string
      description: Method type.
    EndpointType:
      enum:
        - ENDPOINT_TYPE_DEFAULT_OR_PUBLIC
        - ENDPOINT_TYPE_PRIVATE
      type: string
      description: Endpoint type.
    Attachment:
      title: Slack attachment configuration
      type: object
      properties:
        isActive:
          type: boolean
          description: Whether this resource is active.
        type:
          $ref: '#/components/schemas/AttachmentType'
      externalDocs:
        url: ''
    Digest:
      title: Slack digest configuration
      type: object
      properties:
        isActive:
          type: boolean
          description: Whether this resource is active.
        type:
          $ref: '#/components/schemas/DigestType'
      externalDocs:
        url: ''
    AttachmentType:
      enum:
        - EMPTY
        - METRIC_SNAPSHOT
        - LOGS
      type: string
      description: Attachment type.
    DigestType:
      enum:
        - UNKNOWN
        - ERROR_AND_CRITICAL_LOGS
        - FLOW_ANOMALIES
        - SPIKE_ANOMALIES
        - DATA_USAGE
      type: string
      description: Digest type.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````