search

Schedule APIs

Schedule APIs provide functionality to manage and retrieve scheduled tasks and automations within your organization. These APIs allow you to access scheduler configurations, recurring events, and automation workflows.

hashtag
Overview

The Schedule APIs enable you to retrieve and manage scheduled tasks within your organization. Schedulers represent automated recurring events such as board automations, outbound messages, and workflow triggers with configurable frequencies and timing.

hashtag
1. Get User Schedulers by Event Type

Retrieve all schedulers associated with a specific user, filtered by event type.

This API allows you to fetch all scheduled tasks for a user by providing the organization ID, user ID, and optional event type filters. It returns a paginated list of schedulers with their configurations, timing details, and job information.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers?event_type={event_type}

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers?event_type={event_type}

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers?event_type={event_type}

  • Headers:

    • x-access-token: Contact to iMBRACE

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

  • Query Parameters:

    • event_type (string, optional): Filter by event type. Supports multiple values with operators:

      • contains: - Filter schedulers containing any of the specified event types (e.g., contains:whatsapp_outbound,telegram_outbound)

      • Single value - Filter by exact event type (e.g., board_automation)

    • limit (number, optional): Maximum number of results to return (default: 10)

    • skip (number, optional): Number of results to skip for pagination (default: 0)

  • Result:

    • Status code: 200 OK

    {
    "data": [
        {
            "_id": "66e400607c85c0dc11b46f21",
            "type": "recurring",
            "name": "Board Automation - Jane - Facebook 16 days ",
            "event_type": "board_automation",
            "description": "",
            "options": null,
            "job": {
                "type": "kafka",
                "topic": "ROUTER.OUTGOING_CRM_EVENT",
                "data": {
                    "board_id": "brd_67c3766a-bedc-48dc-9a17-84551435cea6",
                    "id": "662f175874c8ca8d00a1d30d"
                },
                "workflow_id": "1336"
            },
            "organization_id": "org_imbrace",
            "internal_id": "662f175874c8ca8d00a1d30d",
            "trigger_frequency_unit": "days",
            "trigger_frequency_value": 1,
            "trigger_time": "2024-04-29T01:00:00.000Z",
            "start_date": "2024-04-29T01:30:00.000Z",
            "start_time": "2024-04-29T01:30:00.000Z",
            "start_datetime": "2024-04-29T01:30:00.000Z",
            "is_paused": true,
            "is_finished": false,
            "channel_source": "",
            "created_by": null,
            "updated_by": null,
            "created_at": "2024-09-13T09:05:36.286Z",
            "updated_at": "2024-09-13T09:05:36.286Z"
        }
    ],
    "count": 10,
    "total": 23,
    "has_more": true
}

  • Error Responses:

    • Status code: 400 Bad Request

    {
    "message": "organization_id is required"
}
    {
    "message": "user_id is required"
}

    • Status code: 401 Unauthorized

    {
    "message": "Unauthorized"
}

    • Status code: 404 Not Found

    {
    "message": "User not found"
}

  • Example:

    curl --location 'https://app-gateway.dev.imbrace.co/3rd/organization/org_imbrace/users/u_imbrace_agent1/schedulers?event_type=contains%3Awhatsapp_outbound%2Ctelegram_outbound' \
--header 'x-access-token: api_2f576a7d-f7eb-4748-9ec0-b295d7204de1'

hashtag
2. Get Scheduler File

Retrieve a specific file associated with a scheduler.

This API allows you to fetch a file attached to a scheduler by providing the organization ID, user ID, scheduler ID, and file ID. This is useful for retrieving attachments or documents associated with scheduled tasks.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}/files/{file_id}

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}/files/{file_id}

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}/files/{file_id}

  • Headers:

    • x-access-token: Contact to iMBRACE

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

    • scheduler_id (string, required): The unique identifier of the scheduler

    • file_id (string, required): The unique identifier of the file

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

hashtag
3. Get Scheduler by ID

Retrieve detailed information about a specific scheduler.

This API allows you to fetch complete scheduler details by providing the organization ID, user ID, and scheduler ID. It returns comprehensive information about the scheduler including its configuration, timing, job details, and status.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Headers:

    • x-access-token: Contact to iMBRACE

    • x-organization-id: The unique identifier of the organization

    • x-user-id: The unique identifier of the user

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

    • scheduler_id (string, required): The unique identifier of the scheduler

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

hashtag
4. Create Scheduler

Create a new scheduler for automated recurring tasks.

This API allows you to create a new scheduler by providing the scheduler configuration including timing, job details, and trigger settings. The scheduler will be created for the specified user within the organization.

  • Endpoint for Product: POST https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers

  • Endpoint for Demo: POST https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers

  • Endpoint for Dev: POST https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers

  • Headers:

    • x-access-token: Contact to iMBRACE

    • x-organization-id: The unique identifier of the organization

    • x-user-id: The unique identifier of the user

    • Content-Type: application/json

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

  • Body:

  • Result:

    • Status code: 201 Created

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

hashtag
5. Create Scheduler with Files

Create a new scheduler with file attachments for automated recurring tasks.

This API allows you to create a new scheduler with file uploads by providing the scheduler configuration and files as multipart form data. This is useful for schedulers that need to send messages with attachments or documents.

  • Endpoint for Product: POST https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/files

  • Endpoint for Demo: POST https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/files

  • Endpoint for Dev: POST https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/files

  • Headers:

    • x-access-token: Contact to iMBRACE

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

  • Form Data:

    • payload (string, required): JSON string containing scheduler configuration

    • files (file, optional): One or more files to upload

  • Payload Structure:

  • Result:

    • Status code: 201 Created

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

hashtag
6. Update Scheduler

Update an existing scheduler's configuration and settings.

This API allows you to update a scheduler by providing the scheduler ID and the fields you want to modify. You can update the scheduler name, timing, job configuration, and status.

  • Endpoint for Product: PUT https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Endpoint for Demo: PUT https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Endpoint for Dev: PUT https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Headers:

    • x-access-token: Contact to iMBRACE

    • x-organization-id: The unique identifier of the organization

    • x-user-id: The unique identifier of the user

    • Content-Type: application/json

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

    • scheduler_id (string, required): The unique identifier of the scheduler

  • Body:

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

hashtag
7. Update Scheduler with Files

Update an existing scheduler with file attachments using multipart form data.

This API allows you to update a scheduler and its associated files by providing the scheduler ID, updated configuration, and new files as multipart form data. This is useful for schedulers that need to send messages with updated attachments or documents.

  • Endpoint for Product: PUT https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/files/{scheduler_id}

  • Endpoint for Demo: PUT https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/files/{scheduler_id}

  • Endpoint for Dev: PUT https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/files/{scheduler_id}

  • Headers:

    • x-access-token: Contact to iMBRACE

    • x-organization-id: The unique identifier of the organization

    • x-user-id: The unique identifier of the user

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

    • scheduler_id (string, required): The unique identifier of the scheduler

  • Form Data:

    • payload (string, required): JSON string containing updated scheduler configuration

    • files (file, optional): One or more files to upload/replace

  • Payload Structure:

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

hashtag
8. Delete Scheduler

Delete a specific scheduler by its ID.

This API allows you to delete a scheduler by providing the scheduler ID and optional scheduler details in the request body. Once deleted, the scheduler will be permanently removed from the system.

  • Endpoint for Product: DELETE https://app-gateway.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Endpoint for Demo: DELETE https://app-gateway.demo.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Endpoint for Dev: DELETE https://app-gateway.dev.imbrace.co/3rd/organization/{organization_id}/users/{user_id}/schedulers/{scheduler_id}

  • Headers:

    • x-access-token: Contact to iMBRACE

    • x-organization-id: The unique identifier of the organization

    • Content-Type: application/json

  • Path Parameters:

    • organization_id (string, required): The unique identifier of the organization

    • user_id (string, required): The unique identifier of the user

    • scheduler_id (string, required): The unique identifier of the scheduler

  • Body:

  • Body Parameters:

    • type (string, optional): Scheduler type (e.g., "recurring", "non_recurring")

    • schedule_id (string, optional): Schedule identifier for confirmation

    • callback_url (string, optional): Callback URL associated with the scheduler

    • start_date (string, optional): Start date of the scheduler

    • start_time (string, optional): Start time of the scheduler

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

PreviousMarketplace APIsNextWorkflows

Last updated