Procore.Api.UtilitiesWebhooksHooks (procore_sdk v0.3.0)

API calls for all endpoints tagged UtilitiesWebhooksHooks.

Summary

Functions

rest_v10_webhooks_hooks_get(connection, procore_company_id, company_id, project_id, opts \\ [])

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

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

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

rest_v10_webhooks_hooks_id_patch(connection, procore_company_id, id, rest_v10_webhooks_hooks_id_patch_request, opts \\ [])

Update Webhooks Hook Hooks must be updated within a company and/or project scope.

rest_v10_webhooks_hooks_post(connection, procore_company_id, rest_v10_webhooks_hooks_post_request, opts \\ [])

Create Webhooks Hook Hooks must be created within a company and/or project scope.

Functions

Link to this function

rest_v10_webhooks_hooks_get(connection, procore_company_id, company_id, project_id, opts \\ [])

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

List Webhooks Hooks Hooks 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.
  • 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
    • :namespace (String.t): Hook namespace to query.
    • :api_version (String.t): API Version

Returns

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

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

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

Delete Webhooks Hook 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.
  • 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, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_webhooks_hooks_id_patch(connection, procore_company_id, id, rest_v10_webhooks_hooks_id_patch_request, opts \\ [])

@spec rest_v10_webhooks_hooks_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10WebhooksHooksIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10WebhooksHooksPost500Response.t()}
  | {:ok, Procore.Model.WebhooksHook.t()}
  | {:error, Tesla.Env.t()}

Update Webhooks Hook Hooks must be updated 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.
  • id (integer()): Webhooks Hook ID
  • rest_v10_webhooks_hooks_id_patch_request (RestV10WebhooksHooksIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_webhooks_hooks_post(connection, procore_company_id, rest_v10_webhooks_hooks_post_request, opts \\ [])

@spec rest_v10_webhooks_hooks_post(
  Tesla.Env.client(),
  integer(),
  Procore.Model.RestV10WebhooksHooksPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10WebhooksHooksPost500Response.t()}
  | {:ok, Procore.Model.WebhooksHook.t()}
  | {:error, Tesla.Env.t()}

Create Webhooks Hook Hooks 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.
  • rest_v10_webhooks_hooks_post_request (RestV10WebhooksHooksPostRequest):
  • opts (keyword): Optional parameters

Returns

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