{ "opencollection": "1.0.0", "info": { "name": "Convoy API Reference", "version": "26.3.5" }, "items": [ { "info": { "name": "Endpoints", "type": "folder" }, "items": [ { "info": { "name": "List All Endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "ownerId", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "The owner ID of the endpoint" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "q", "value": "endpoint-1", "type": "query", "description": "The name of the endpoint" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches an endpoints" }, { "info": { "name": "Create an Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates an endpoint" }, { "info": { "name": "Test OAuth2 Connection", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/oauth2/test", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint tests the OAuth2 connection by attempting to exchange a token" }, { "info": { "name": "Retrieve Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "endpointID", "value": "", "type": "path", "description": "Endpoint ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches an endpoint" }, { "info": { "name": "Update an Endpoint", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "endpointID", "value": "", "type": "path", "description": "Endpoint ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates an endpoint" }, { "info": { "name": "Delete Endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "endpointID", "value": "", "type": "path", "description": "Endpoint ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint deletes an endpoint" }, { "info": { "name": "Activate Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID/activate", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "endpointID", "value": "", "type": "path", "description": "Endpoint ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Activated an inactive endpoint" }, { "info": { "name": "Roll Endpoint Secret", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID/expire_secret", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "endpointID", "value": "", "type": "path", "description": "Endpoint ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint expires and re-generates the endpoint secret." }, { "info": { "name": "Pause Endpoint", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/endpoints/:endpointID/pause", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "endpointID", "value": "", "type": "path", "description": "Endpoint ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Toggles an endpoint's status between active and paused states" } ] }, { "info": { "name": "EventTypes", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a Project's Event Types", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches the project's event types" }, { "info": { "name": "Create an Event Type", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates an event type" }, { "info": { "name": "Import Event Types From OpenAPI Spec", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types/import", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint imports event types from an OpenAPI specification" }, { "info": { "name": "Updates an Event Type", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types/:eventTypeId", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates an event type" }, { "info": { "name": "Deprecates an Event Type", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/event-types/:eventTypeId/deprecate", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventTypeId", "value": "", "type": "path", "description": "Event Type ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint deprecates an event type" } ] }, { "info": { "name": "Event Deliveries", "type": "folder" }, "items": [ { "info": { "name": "List All Event Deliveries", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "endDate", "value": "2008-05-02T15:04:05", "type": "query", "description": "The end date" }, { "name": "endpointId", "value": "", "type": "query", "description": "A list of endpoint IDs to filter by" }, { "name": "eventId", "value": "", "type": "query", "description": "Event ID to filter by" }, { "name": "event_type", "value": "", "type": "query", "description": "EventType to filter by" }, { "name": "idempotencyKey", "value": "", "type": "query", "description": "IdempotencyKey to filter by" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" }, { "name": "startDate", "value": "2006-01-02T15:04:05", "type": "query", "description": "The start date" }, { "name": "status", "value": "", "type": "query", "description": "A list of event delivery statuses to filter by" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "SubscriptionID to filter by" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves all event deliveries paginated." }, { "info": { "name": "Batch Retry Event Delivery", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/batchretry", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "endDate", "value": "2008-05-02T15:04:05", "type": "query", "description": "The end date" }, { "name": "endpointId", "value": "", "type": "query", "description": "A list of endpoint IDs to filter by" }, { "name": "eventId", "value": "", "type": "query", "description": "Event ID to filter by" }, { "name": "event_type", "value": "", "type": "query", "description": "EventType to filter by" }, { "name": "idempotencyKey", "value": "", "type": "query", "description": "IdempotencyKey to filter by" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" }, { "name": "startDate", "value": "2006-01-02T15:04:05", "type": "query", "description": "The start date" }, { "name": "status", "value": "", "type": "query", "description": "A list of event delivery statuses to filter by" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "SubscriptionID to filter by" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint batch retries multiple event deliveries at once." }, { "info": { "name": "Force Retry Event Delivery", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/forceresend", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint enables you retry a previously successful event delivery" }, { "info": { "name": "Retrieve an Event Delivery", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventDeliveryID", "value": "", "type": "path", "description": "event delivery id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches an event delivery." }, { "info": { "name": "Retry Event Delivery", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID/resend", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventDeliveryID", "value": "", "type": "path", "description": "event delivery id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retries an event delivery." } ] }, { "info": { "name": "Delivery Attempts", "type": "folder" }, "items": [ { "info": { "name": "List Delivery Attempts", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID/deliveryattempts", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventDeliveryID", "value": "", "type": "path", "description": "event delivery id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches an app message's delivery attempts" }, { "info": { "name": "Retrieve a Delivery Attempt", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/eventdeliveries/:eventDeliveryID/deliveryattempts/:deliveryAttemptID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventDeliveryID", "value": "", "type": "path", "description": "event delivery id" }, { "name": "deliveryAttemptID", "value": "", "type": "path", "description": "delivery attempt id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches an app event delivery attempt" } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "List All Events", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "endDate", "value": "2008-05-02T15:04:05", "type": "query", "description": "The end date" }, { "name": "endpointId", "value": "", "type": "query", "description": "A list of endpoint ids to filter by" }, { "name": "idempotencyKey", "value": "", "type": "query", "description": "IdempotencyKey to filter by" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "query", "value": "", "type": "query", "description": "Any arbitrary value to filter the events payload" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" }, { "name": "sourceId", "value": "", "type": "query", "description": "A list of Source IDs to filter the events by." }, { "name": "startDate", "value": "2006-01-02T15:04:05", "type": "query", "description": "The start date" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches app events with pagination" }, { "info": { "name": "Create an Event", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates an endpoint event" }, { "info": { "name": "Batch Replay Events", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events/batchreplay", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "endDate", "value": "2008-05-02T15:04:05", "type": "query", "description": "The end date" }, { "name": "endpointId", "value": "", "type": "query", "description": "A list of endpoint ids to filter by" }, { "name": "idempotencyKey", "value": "", "type": "query", "description": "IdempotencyKey to filter by" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "query", "value": "", "type": "query", "description": "Any arbitrary value to filter the events payload" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" }, { "name": "sourceId", "value": "", "type": "query", "description": "A list of Source IDs to filter the events by." }, { "name": "startDate", "value": "2006-01-02T15:04:05", "type": "query", "description": "The start date" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint replays multiple events at once." }, { "info": { "name": "Create a Broadcast Event", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events/broadcast", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates a event that is broadcast to every endpoint whose subscription matches the given event type." }, { "info": { "name": "Dynamic Events", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events/dynamic", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint does not require creating endpoint and subscriptions ahead of time. Instead, you supply the endpoint and the payload, and Convoy delivers the events" }, { "info": { "name": "Fan Out an Event", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events/fanout", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint uses the owner_id to fan out an event to multiple endpoints." }, { "info": { "name": "Retrieve an Event", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events/:eventID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventID", "value": "", "type": "path", "description": "event id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves an event" }, { "info": { "name": "Replay Event", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/events/:eventID/replay", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "eventID", "value": "", "type": "path", "description": "event id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint replays an event afresh assuming it is a new event." } ] }, { "info": { "name": "Meta Events", "type": "folder" }, "items": [ { "info": { "name": "List All Meta Events", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/meta-events", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "endDate", "value": "2008-05-02T15:04:05", "type": "query", "description": "The end date" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" }, { "name": "startDate", "value": "2006-01-02T15:04:05", "type": "query", "description": "The start date" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches meta events with pagination" }, { "info": { "name": "Retrieve a Meta Event", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/meta-events/:metaEventID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "metaEventID", "value": "", "type": "path", "description": "meta event id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a meta event" }, { "info": { "name": "Retry Meta Event", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/meta-events/:metaEventID/resend", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "metaEventID", "value": "", "type": "path", "description": "meta event id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retries a meta event" } ] }, { "info": { "name": "Onboard", "type": "folder" }, "items": [ { "info": { "name": "Bulk Onboard Endpoints with Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/onboard", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "dry_run", "value": "", "type": "query", "description": "Validate without creating" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint accepts a CSV file or JSON body to bulk-create endpoints with subscriptions" } ] }, { "info": { "name": "Portal Links", "type": "folder" }, "items": [ { "info": { "name": "List All Portal Links", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "ownerId", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "The owner ID of the endpoint" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "q", "value": "endpoint-1", "type": "query", "description": "The name of the endpoint" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches multiple portal links" }, { "info": { "name": "Create a Portal Link", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates a portal link" }, { "info": { "name": "Retrieve a Portal Link", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "portalLinkID", "value": "", "type": "path", "description": "portal link id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a portal link by its id." }, { "info": { "name": "Update a Portal Link", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "portalLinkID", "value": "", "type": "path", "description": "portal link id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates a portal link" }, { "info": { "name": "Get a Portal Link Auth Token", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID/refresh_token", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "portalLinkID", "value": "", "type": "path", "description": "portal link id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a portal link auth token" }, { "info": { "name": "Revoke a Portal Link", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/portal-links/:portalLinkID/revoke", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "portalLinkID", "value": "", "type": "path", "description": "portal link id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint revokes a portal link" } ] }, { "info": { "name": "Sources", "type": "folder" }, "items": [ { "info": { "name": "List All Sources", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/sources", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "provider", "value": "twitter", "type": "query", "description": "The custom source provider e.g. twitter, shopify" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" }, { "name": "type", "value": "http", "type": "query", "description": "The source type e.g. http, pub_sub" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches multiple sources" }, { "info": { "name": "Create a Source", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/sources", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates a source" }, { "info": { "name": "Retrieve a Source", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/sources/:sourceID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "sourceID", "value": "", "type": "path", "description": "Source ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a source by its id" }, { "info": { "name": "Update a Source", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/sources/:sourceID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "sourceID", "value": "", "type": "path", "description": "source id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates a source" }, { "info": { "name": "Delete a Source", "type": "http" }, "http": { "method": "DELETE", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/sources/:sourceID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "sourceID", "value": "", "type": "path", "description": "source id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint deletes a source" } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Validate Source Function", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/sources/test_function", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint validates that a filter will match a certain payload structure." }, { "info": { "name": "List All Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "direction", "value": "", "type": "query" }, { "name": "endpointId", "value": "", "type": "query", "description": "A list of endpointIDs to filter by" }, { "name": "name", "value": "", "type": "query", "description": "Subscription name to filter by" }, { "name": "next_page_cursor", "value": "01H0JA5MEES38RRK3HTEJC647K", "type": "query", "description": "A pagination cursor to fetch the next page of a list" }, { "name": "perPage", "value": "20", "type": "query", "description": "The number of items to return per page" }, { "name": "prev_page_cursor", "value": "01H0JATTVCXZK8FRDX1M1JN3QY", "type": "query", "description": "A pagination cursor to fetch the previous page of a list" }, { "name": "sort", "value": "ASC | DESC", "type": "query", "description": "Sort order, values are `ASC` or `DESC`, defaults to `DESC`" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches all the subscriptions" }, { "info": { "name": "Create a Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates a subscriptions" }, { "info": { "name": "Validate Subscription Filter", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/test_filter", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint validates that a filter will match a certain payload structure." }, { "info": { "name": "Test a Subscription Function", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/test_function", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint test runs a transform function against a payload." }, { "info": { "name": "Retrieve a Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "subscription id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a single subscription" }, { "info": { "name": "Update a Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "subscription id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates a subscription" }, { "info": { "name": "Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "subscription id" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint deletes a subscription" } ] }, { "info": { "name": "Filters", "type": "folder" }, "items": [ { "info": { "name": "List All Filters", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint fetches all filters for a subscription" }, { "info": { "name": "Create a New Filter", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates a new filter for a subscription" }, { "info": { "name": "Create Multiple Subscription Filters", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters/bulk", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint creates multiple filters for a subscription" }, { "info": { "name": "Update Multiple Subscription Filters", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters/bulk_update", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates multiple filters for a subscription" }, { "info": { "name": "Test a Filter", "type": "http" }, "http": { "method": "POST", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters/test/:eventType", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "eventType", "value": "", "type": "path", "description": "Event Type" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint tests a filter against a payload" }, { "info": { "name": "Get a Filter", "type": "http" }, "http": { "method": "GET", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters/:filterID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "filterID", "value": "", "type": "path", "description": "Filter ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint retrieves a single filter" }, { "info": { "name": "Update a Filter", "type": "http" }, "http": { "method": "PUT", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters/:filterID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "filterID", "value": "", "type": "path", "description": "Filter ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint updates an existing filter" }, { "info": { "name": "Delete a Filter", "type": "http" }, "http": { "method": "DELETE", "url": "https://us.getconvoy.cloud/api/v1/projects/:projectID/subscriptions/:subscriptionID/filters/:filterID", "params": [ { "name": "projectID", "value": "", "type": "path", "description": "Project ID" }, { "name": "subscriptionID", "value": "", "type": "path", "description": "Subscription ID" }, { "name": "filterID", "value": "", "type": "path", "description": "Filter ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint deletes a filter" } ] } ], "bundled": true }