Endpoints

Get endpoints

Query endpoints() allows to get a list of endpoints where notifications can be sent to.

endpoints(filter: JSON = null
ids: [ID] = null
limit: Int = null
offset: Int = null
order: [String] = null
withArchived: WithArchived = null): EndpointCollection!

Input parameters:

filter: JSON: You can filter a list of endpoints by specifying one or several parameters:

• creation_date: Exact endpoint creation date in ISO 8601 format
• id: ID assigned to endpoint from the database
• is_active:
• last_modified: Exact date of the last endpoint modification in ISO 8601 format
• meta: JSON that contains the data for reaching an endpoint
• triggers: ID assigned to a trigger that activates notifications
• type: The parameter sorts the endpoints by type (WI = WebInterface, EM = Email, WH = Webhook)
• workspace: Workspace ID
• workspace_id: Workspace ID

ids: [ID]: To get a list with certain endpoints, specify their IDs in the list.

limit: Int: The parameter allows to get the first n profiles from the list.

offset: Int: The parameter allows to remove the first n profiles from the list.

order: [String]: Sorting endpoints according to the following parameters:

• creation_date: Sort endpoints by creation date in chronological order
• last_modified: Sort endpoints by last modified date in chronological order
• id: Numerical and alphabetical sorting of endpoints by identifiers
• meta: Sort endpoints by metadata
• triggers: Numerical and alphabetical sorting of endpoints by trigger IDs
• type: Sorting endpoints by type (WI = web interface, EM = Email, WH = webhook)

withArchived: WithArchived: To get all endpoints including the archived ones, specify all. To get only archived endpoints, specify archived.

Output parameters:

EndpointCollection!:Query result is a list of endpoints that contains the following parameters:

• totalCount: Number of returned endpoints
• profiles: [EndpointOutput!]!:
  
  • id: ID!: Endpoint ID
  • type: EndpointType!: Endpoint type can have the following values: Email, Webhook or WebInterface
  • meta: JSONString!: Endpoint meta-information for reaching this endpoint
  • lastModified: DateTime!: Last endpoint modification date in ISO 8601 format
  • creationDate: DateTime!: Endpoint creation date in ISO 8601 format
  • defaultAlias: DefaultAlias:
    
    • OWNER_EMAIL
    • WEB_INTERFACE
  • archived: Boolean!: Attribute that the endpoint is archived.

Example Request:

{
  endpoints(ids: ["6fd67f81-a195-442b-a991-1a0eca6bbb69"]) {
    totalCount
    collectionItems {
      archived
      creationDate
      id
      defaultAlias
      lastModified
      meta
      type
    }
  }
}

Example Response:

API returns the following result:

{
  "data": {
    "endpoints": {
      "totalCount": 1,
      "collectionItems": [
        {
          "archived": false,
          "creationDate": "2022-07-07T07:21:06.421413+00:00",
          "id": "6fd67f81-a195-442b-a991-1a0eca6bbb69",
          "defaultAlias": "OWNER_EMAIL",
          "lastModified": "2022-07-07T07:21:06.421425+00:00",
          "meta": "{\"target_email\": \"aa@aa.ru\", \"default_alias\": \"owner_email\"}",
          "type": "Email"
        }
      ]
    }
  }
}

Create an email endpoint

Mutation createEmailEndpoint() allows to create a new endpoint of Email type.

createEmailEndpoint(endpointData: EmailEndpointInput!): EndpointManageOutput!

Input parameters:

endpointData: EmailEndpointInput!: JSON with the information required for creating an endpoint:

• targetEmail: String!: Email where notifications will be sent to.

Output parameters:

EndpointManageOutput!: The mutation result is JSON that contains the following parameters:

• ok: Boolean!: Attribute that mutation is successfully completed
• endpoint: EndpointOutput!: New endpoint object

Example Request:

mutation {
  createEmailEndpoint(endpointData: {targetEmail: "test@test.com"}) {
    ok
    endpoint {
      id
      archived
      creationDate
      defaultAlias
      lastModified
      meta
      type
    }
  }
}

Example Response:

API returns the following result:

{
  "data": {
    "createEmailEndpoint": {
      "ok": true,
      "endpoint": {
        "id": "2eff291d-8c8c-4325-8953-5a70b31bc63e",
        "archived": false,
        "creationDate": "2022-07-10T12:27:22.568988+00:00",
        "defaultAlias": null,
        "lastModified": "2022-07-10T12:27:22.569003+00:00",
        "meta": "{\"target_email\": \"test@test.com\"}",
        "type": "EMAIL"
      }
    }
  }
}

Create a webhook endpoint

Mutation createWebhookEndpoint() allows to create a new endpoint of Webhook type.

createWebhookEndpoint(endpointData: WebhookEndpointInput!): EndpointManageOutput!

Input parameters:

endpointData: WebhookEndpointInput!: JSON with the information required for creating an endpoint:

• url: String!: URL where requests will be sent to
• requestMethod: String!: Request method

Output parameters:

EndpointManageOutput!: The mutation result is JSON that contains the following parameters:

• ok: Boolean!: Attribute that mutation is successfully completed
• endpoint: EndpointOutput!: New endpoint object

Example Request:

mutation {
  createWebhookEndpoint(endpointData: {url: "https://endpoint_test.requestcatcher.com/test /", requestMethod: "POST"}) {
    ok
    endpoint {
      archived
      creationDate
      defaultAlias
      id
      lastModified
      meta
      type
    }
  }
}

Example Response:

API returns the following result:

{
  "data": {
    "createWebhookEndpoint": {
      "ok": true,
      "endpoint": {
        "archived": false,
        "creationDate": "2022-07-10T12:42:34.957171+00:00",
        "defaultAlias": null,
        "id": "afd7c121-3140-4a8c-b0ee-3717581eb76d",
        "lastModified": "2022-07-10T12:42:34.957188+00:00",
        "meta": "{\"url\": \"https://endpoint_test.requestcatcher.com/test /\", \"method\": \"POST\"}",
        "type": "WEBHOOK"
      }
    }
  }
}

Update an endpoint

Mutation updateEndpoint() allows to update the endpoint information.

updateEndpoint(endpointId: ID!
endpointInfo: JSON): EndpointManageOutput!

Input parameters:

endpointId: ID!: Endpoint ID

endpointInfo: JSON: JSON-object with parameters to be updated. These parameters are similar to the parameters from meta: JSON

Output parameters:

EndpointManageOutput!: The mutation result is JSON that contains the following parameters:

• ok: Boolean!: Attribute that mutation is successfully completed
• endpoint: EndpointOutput!: Updated endpoint object

Incorrect input errors:

• Endpoint not found by transmitted id:

  {
        "message": "Endpoint matching query does not exist."
  }

Example Request:

mutation {
  updateEndpoint(endpointId: "6fd67f81-a195-442b-a991-1a0eca6bbb69", endpointInfo: {target_email: "new-email@test.com"}) {
    ok
    endpoint {
      id
      meta
    }
  }
}

Example Response:

API returns the following result:

{
  "data": {
    "updateEndpoint": {
      "ok": true,
      "endpoint": {
        "id": "6fd67f81-a195-442b-a991-1a0eca6bbb69",
        "meta": "{\"target_email\": \"new-email@test.com\", \"default_alias\": \"owner_email\"}"
      }
    }
  }
}

Delete an endpoint

Mutation deleteEndpoint() is used to archive a list of endpoints.

deleteEndpoint(endpointIds: [String!]!): MutationResult!

Input parameters:

endpointIds: [String!]!: List of endpoint IDs

Output parameters:

MutationResult!: The mutation result is JSON that contains the following parameters:

• ok: Boolean!: Attribute that mutation is successfully completed

Example Request:

mutation {
  deleteEndpoint(endpointIds: ["2eff291d-8c8c-4325-8953-5a70b31bc63e", "29bcfb3a-3a26-4544-9def-d5d44bbd3be4"]) {
    ok
  }
}

Example Response:

API returns the following result:

{
  "data": {
    "deleteEndpoint": {
      "ok": true
    }
  }
}