If you want to receive data from Zapier, you can do so by setting the Zapier Webhook as the Action for your Zap.

Create Webhook Endpoint in WP-CRM System

In the Zapier Webhook settings you will need to enter a webhook URL, which can be created by following these steps.

  • Visit WP-CRM System > Dashboard > Zapier tab
  • Click the Incoming (Action) link at the top
  • Enter a descriptive name for the Zap (this is for internal purposes only)
  • Use the Secret provided, or enter your own. You can use any random letter/number string here.
  • Select Yes under Is Zap Active?
  • For the record type, select the type of record that should be affected by the Zap.
  • Under Action select what you want to have happen.
    • Create: This will only create a record if one with the same title does not already exist.
    • Update & Create: This will create a record if one with the same title does not already exist. Otherwise, it will update the existing record.
    • Update: This will only update existing records and will not create new records.

  • Click Save Zaps when you're finished.

Under the fields you just edited, there should be a URL that looks like this: https://yoursite.com/wpcrmsystem-zapier-api?id=1&secret=abc123&type=wpcrm-campaign&action=create 

Copy that URL, you will need it to set up your webhook in Zapier.

Setup Zap with Webhook Action

First you will need to set up a Trigger in Zapier. This is where your data will be coming from. There are over 1,000 different apps available to use as a trigger, so we won't cover how to set that up here. 

Once your Trigger is set up, you can create the Action.

  • Select Webhooks under the Built-In Apps section
  • Under the Create section select POST
  • On the Edit Template section, paste the URL that you created earlier in to the URL field
  • Select Json under Payload Type if it isn't already selected.
  • Data will vary based on the record type (see Data section below)
  • Wrap Request In Array: choose No
  • File: Leave blank
  • Unflatten: choose Yes
  • Basic Auth: If your site requires a username and password combination before it can be viewed, enter that information here (note this is not your WordPress username and password). If you are unsure, leave this blank.
  • Headers: Leave blank.

Data

Each record type (contact, organization, project, etc.) will have its own unique set of data that it can receive. 

The data in Zapier is set up in a key/value pair. 

The key is the name we give to the field in order to identify the data coming into WP-CRM System. This is what will be entered into the left column of the Data section. You must use the correct key in order for the data to be passed to WP-CRM System correctly. 

The value is the actual data that is coming from some other app through Zapier. This is what you will select in the right column of the Data section. 

Notes: 

All keys provided below are case sensitive.  

Custom Fields are only applicable if using the Custom Fields extension.

Contact Keys

  • prefix
    • This is the name prefix (i.e. Mr, Mrs, etc.)

  • first_name
  • last_name
  • org
    • This should be the organization's name as it exists in WP-CRM System. If the organization does not exist, a new one will be created.

  • role
    • This is the role the contact has in their organization (i.e. Owner, etc.)

  • url
  • email
  • phone
  • mobile
  • fax
  • address_1
  • address_2
  • city
  • state
  • postal
  • country
  • additional
  • categories
    • This expects a comma separated list of existing category names.

  • Custom Fields
    • Enter the title of the custom field as it is displayed in your Contact edit screen in as the key.

Organization Keys

  • title
  • phone
  • email
  • url
  • address_1
  • address_2
  • city
  • state
  • postal
  • country
  • additional
  • categories
    • This expects a comma separated list of existing category names.

  • Custom Fields
    • Enter the title of the custom field as it is displayed in your Organization edit screen in as the key.

Project Keys

  • title
  • value
  • close_date
    • This can be any date format (i.e. November 11, 2018 or 11 November 2018 should both work)

  • status
  • progress
  • org
    • This should be the organization's name as it exists in WP-CRM System. If the organization does not exist, a new one will be created.

  • contact
    • This should be the contact's name as it exists in WP-CRM System. If the contact does not exist, a new one will be created.

  • assigned
    • This can be either the WP-CRM System user's email address or display name who is assigned to the project.

  • additional
  • categories
    • This expects a comma separated list of existing category names.

  • Custom Fields
    • Enter the title of the custom field as it is displayed in your Project edit screen in as the key.

Task Keys

  • title
  • org
    • This should be the organization's name as it exists in WP-CRM System. If the organization does not exist, a new one will be created.

  • contact
    • This should be the contact's name as it exists in WP-CRM System. If the contact does not exist, a new one will be created.

  • project
    • This should be the project's name as it exists in WP-CRM System. If the project does not exist, a new one will be created.

  • assigned
    • This can be either the WP-CRM System user's email address or display name who is assigned to the project.

  • start_date
    • This can be any date format (i.e. November 11, 2018 or 11 November 2018 should both work)

  • due_date
    • This can be any date format (i.e. November 11, 2018 or 11 November 2018 should both work)

  • progress
  • priority
  • status
  • additional
  • categories
    • This expects a comma separated list of existing category names.

  • Custom Fields
    • Enter the title of the custom field as it is displayed in your Task edit screen in as the key.

Opportunity Keys

  • title
  • org
    • This should be the organization's name as it exists in WP-CRM System. If the organization does not exist, a new one will be created.

  • contact
    • This should be the contact's name as it exists in WP-CRM System. If the contact does not exist, a new one will be created.

  • campaign
    • This should be the campaign's name as it exists in WP-CRM System. If the campaign does not exist, a new one will be created.

  • assigned
    • This can be either the WP-CRM System user's email address or display name who is assigned to the opportunity.

  • probability
  • close_date
    • This can be any date format (i.e. November 11, 2018 or 11 November 2018 should both work)

  • value
  • won_lost
  • additional
  • categories
    • This expects a comma separated list of existing category names.

  • Custom Fields
    • Enter the title of the custom field as it is displayed in your Opportunity edit screen in as the key.

Campaign Keys

  • title
  • active
  • assigned
    • This can be either the WP-CRM System user's email address or display name who is assigned to the campaign.

  • status
  • start_date
    • This can be any date format (i.e. November 11, 2018 or 11 November 2018 should both work)

  • end_date
    • This can be any date format (i.e. November 11, 2018 or 11 November 2018 should both work)

  • reach
    • This should be the projected reach

  • responses
  • budget_cost
  • actual_cost
  • org
    • This should be the organization's name as it exists in WP-CRM System. If the organization does not exist, a new one will be created.

  • contact
    • This should be the contact's name as it exists in WP-CRM System. If the contact does not exist, a new one will be created.

  • additional
  • categories
    • This expects a comma separated list of existing category names.

  • Custom Fields
    • Enter the title of the custom field as it is displayed in your Campaign edit screen in as the key.