Endpoint API

Finout’s Endpoint API provides functionalities to query existing endpoints and create new ones effortlessly. You can retrieve a list of current endpoints or create new ones, with all results returned in JSON format for seamless integration and processing.

GET/Endpoints

Gets a list of all your account endpoints.

Prerequisites

• Generate a Client ID and Secret Key from Finout to add in Headers.

Request https://app.finout.io/v1/endpoints

Response

200

{ 
"endpoints": [
          {
            "type": "email",
            "name": "[email protected]",
            "configuration": {
                "to": "[email protected]"
            },
            "createdBy": "example",
            "createdAt": "Thu Dec 28 2023 14:09:57 GMT+0000 (Greenwich Mean Time)",
            "id": "7fecf9fb-4f36-4931-8d02-9cc53bb26af3"
        },
        {
            "type": "slack",
            "name": "Demo-Finout",
            "configuration": {
                "to": "https://hooks.slack.com/services/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"
            },
            "createdBy": "Demo-Finout",
            "createdAt": "Sun Feb 26 2023 14:33:35 GMT+0000 (Greenwich Mean Time)",
            "id": "4f806937-6f5b-478e-a81a-f4b2ece14bb1"
        },
        {
            "type": "msteams",
            "name": "BI Group/DevTeam",
            "createdBy": "Finout",
            "createdAt": "Wed Nov 13 2024 17:44:50 GMT+0000 (Greenwich Mean Time)",
            "id": "a4a41dfc-23b3-4d9d-8f17-6e45cc34e8f8"
        },
   ],
    "requestId": "3b4c8ee0-9d97-4042-8265-ce837a87469d"
}

400

Bad Request

401

Unauthorized

429

Too many requests

503

Server unavailable

504

Gateway Timeout

Returns a JSON object with the following properties:

• type: The endpoint type - email or Slack.

• name: The name of the endpoint.

• configuration: The Slack or email URL that is configured for the endpoint.

• to: The destination address or endpoint for the notification.

• createdBy: The creator of the endpoint.

• createdAt: The time and date the endpoint was created.

• id: The unique identifier of your account's views.

• requestId: The ID of this specific request.

POST /Endpoints

Creates an email or Slack endpoint in Finout.

Prerequisites

• Generate a Client ID and Secret Key from Finout to add in Headers.

Request

https://app.finout.io/v1/endpoints

200

{
    "type": "email",
    "name": "demo",
    "configuration": {
        "to": "[email protected]"
    }
}

Body of Request

Parameter	Type	Description
type	string	Email or Slack
name	string	The name of the endpoint.
configuration	Object	The address where notifications or messages are sent. ​to: The destination address or endpoint for the notification.

Note: For MS Teams - All public channels in a Team will automatically mapped to an endpoint ID in Finout.

Response

200

{
    "endpoint": {
        "accountId": "e6ad4c08-9ecd-4592-be61-7a13ad456259",
        "createdBy": "[email protected]",
        "type": "email",
        "name": "demo",
        "configuration": {
            "to": "[email protected]"
        },
        "createdAt": "Tue Oct 29 2024 12:11:10 GMT+0000 (Greenwich Mean Time)",
        "updatedAt": "Tue Oct 29 2024 12:11:10 GMT+0000 (Greenwich Mean Time)",
        "id": "727e16d6-affe-43bd-924a-c896197640bb"
    },
    "requestId": "0e2516ba-87fb-4210-be7e-6890fcb55adc"
}

400

Bad Request

401

Unauthorized

429

Too many requests

503

Server unavailable

504

Gateway Timeout

Returns a JSON object with the following properties:

• accountId: The account id of the endpoint.

• createdby: The creator of the endpoint.

• type: the endpoint type - email or Slack.

• name: The name of the endpoint.

• configuration: What the endpoint was configured to.

• to: The destination address or endpoint for the notification.

• createdAt: The time and date the endpoint was created.

• updatedAt: The time and date the endpoint was updated.

• id: The unique identifier of your account's views.

• requestId: The ID of this specific request.