Procore.Api.UtilitiesWebhooksTriggers (procore_sdk v0.3.0)

API calls for all endpoints tagged UtilitiesWebhooksTriggers.

Summary

Functions

rest_v10_webhooks_hooks_hook_id_triggers_bulk_delete(connection, procore_company_id, hook_id, rest_v10_webhooks_hooks_hook_id_triggers_bulk_delete_request, opts \\ [])

Bulk Delete Triggers Delete multiple webhook triggers in a single request. All triggers must be within the same hook, and provide company and/or project scope. Max 500 triggers.

rest_v10_webhooks_hooks_hook_id_triggers_bulk_post(connection, procore_company_id, hook_id, rest_v10_webhooks_hooks_hook_id_triggers_bulk_post_request, opts \\ [])

Bulk Create Triggers Create multiple webhook triggers in a single request. All triggers must be within the same hook, and provide company and/or project scope. Max 500 triggers.

rest_v10_webhooks_hooks_hook_id_triggers_get(connection, procore_company_id, hook_id, company_id, project_id, opts \\ [])

List Webhooks Triggers Triggers must be listed within a company and/or project scope.

rest_v10_webhooks_hooks_hook_id_triggers_id_delete(connection, procore_company_id, hook_id, id, company_id, project_id, opts \\ [])

Delete Webhooks Trigger Triggers must be deleted within a company and/or project scope.

rest_v10_webhooks_hooks_hook_id_triggers_post(connection, procore_company_id, hook_id, rest_v10_webhooks_hooks_hook_id_triggers_post_request, opts \\ [])

Create Webhooks Trigger Triggers must be created within a company and/or project scope.

Functions

Link to this function

rest_v10_webhooks_hooks_hook_id_triggers_bulk_delete(connection, procore_company_id, hook_id, rest_v10_webhooks_hooks_hook_id_triggers_bulk_delete_request, opts \\ [])

@spec rest_v10_webhooks_hooks_hook_id_triggers_bulk_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkDeleteRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, nil}
  | {:ok,
     Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkDelete207Response.t()}
  | {:ok,
     Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkDelete200Response.t()}
  | {:ok,
     Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkPost413Response.t()}
  | {:error, Tesla.Env.t()}

Bulk Delete Triggers Delete multiple webhook triggers in a single request. All triggers must be within the same hook, and provide company and/or project scope. Max 500 triggers.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • hook_id (integer()): Webhooks Hook ID
  • rest_v10_webhooks_hooks_hook_id_triggers_bulk_delete_request (RestV10WebhooksHooksHookIdTriggersBulkDeleteRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkDelete200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_webhooks_hooks_hook_id_triggers_bulk_post(connection, procore_company_id, hook_id, rest_v10_webhooks_hooks_hook_id_triggers_bulk_post_request, opts \\ [])

@spec rest_v10_webhooks_hooks_hook_id_triggers_bulk_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, nil}
  | {:ok,
     Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkPost207Response.t()}
  | {:ok,
     Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkPost413Response.t()}
  | {:ok,
     Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkPost200Response.t()}
  | {:error, Tesla.Env.t()}

Bulk Create Triggers Create multiple webhook triggers in a single request. All triggers must be within the same hook, and provide company and/or project scope. Max 500 triggers.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • hook_id (integer()): Webhooks Hook ID
  • rest_v10_webhooks_hooks_hook_id_triggers_bulk_post_request (RestV10WebhooksHooksHookIdTriggersBulkPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10WebhooksHooksHookIdTriggersBulkPost200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_webhooks_hooks_hook_id_triggers_get(connection, procore_company_id, hook_id, company_id, project_id, opts \\ [])

@spec rest_v10_webhooks_hooks_hook_id_triggers_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.WebhooksTrigger.t()]}
  | {:error, Tesla.Env.t()}

List Webhooks Triggers Triggers must be listed within a company and/or project scope.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • hook_id (integer()): Webhooks Hook ID
  • company_id (integer()): Unique identifier for the company. You must supply either a company_id or project_id.
  • project_id (integer()): Unique identifier for the project. You must supply either a company_id or project_id.
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%WebhooksTrigger{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_webhooks_hooks_hook_id_triggers_id_delete(connection, procore_company_id, hook_id, id, company_id, project_id, opts \\ [])

@spec rest_v10_webhooks_hooks_hook_id_triggers_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Delete Webhooks Trigger Triggers must be deleted within a company and/or project scope.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • hook_id (integer()): Webhooks Hook ID
  • id (integer()): Webhooks Trigger ID
  • company_id (integer()): Unique identifier for the company. You must supply either a company_id or project_id.
  • project_id (integer()): Unique identifier for the project. You must supply either a company_id or project_id.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_webhooks_hooks_hook_id_triggers_post(connection, procore_company_id, hook_id, rest_v10_webhooks_hooks_hook_id_triggers_post_request, opts \\ [])

@spec rest_v10_webhooks_hooks_hook_id_triggers_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10WebhooksHooksHookIdTriggersPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.WebhooksTrigger.t()}
  | {:error, Tesla.Env.t()}

Create Webhooks Trigger Triggers must be created within a company and/or project scope.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • hook_id (integer()): Webhooks Hook ID
  • rest_v10_webhooks_hooks_hook_id_triggers_post_request (RestV10WebhooksHooksHookIdTriggersPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.WebhooksTrigger.t} on success
  • {:error, Tesla.Env.t} on failure