webhookTarget

QUERY

webhookTarget(webhookTargetId: ID!): WebhookTarget

Arguments

webhookTargetId

ID!

required

Returns

WebhookTarget

ID!

url

String!

description

String!

eventSubscriptions

[WebhookTargetEventSubscription!]!

The list of event types this target is subscribed to.

version

String!

The webhook schema version this target is pinned to (e.g. '2024-01-01'). All events delivered to this target conform to that version's schema.

isEnabled

Boolean!

When false, Plain will not attempt to deliver any events to this target until it is re-enabled.

createdAt

createdBy

updatedAt

updatedBy

Query

query WebhookTarget($webhookTargetId: ID!) {
  webhookTarget(webhookTargetId: $webhookTargetId) {
    id
    url
    description
    eventSubscriptions {
      eventType
    }
    version
    isEnabled
  }
}

Variables

{
  "webhookTargetId": "id"
}

Response

{
  "data": {
    "webhookTarget": {
      "id": "id",
      "url": "string",
      "description": "string",
      "eventSubscriptions": [
        {
          "eventType": "string"
        }
      ],
      "version": "string",
      "isEnabled": true
    }
  }
}

⌘I

Query

query WebhookTarget($webhookTargetId: ID!) {
  webhookTarget(webhookTargetId: $webhookTargetId) {
    id
    url
    description
    eventSubscriptions {
      eventType
    }
    version
    isEnabled
  }
}

Variables

{
  "webhookTargetId": "id"
}

Response

{
  "data": {
    "webhookTarget": {
      "id": "id",
      "url": "string",
      "description": "string",
      "eventSubscriptions": [
        {
          "eventType": "string"
        }
      ],
      "version": "string",
      "isEnabled": true
    }
  }
}

Queries

Mutations

Types

Arguments

Returns